Class RecursiveComparisonConfiguration
- java.lang.Object
-
- org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration
-
- org.assertj.core.api.recursive.comparison.RecursiveComparisonConfiguration
-
public class RecursiveComparisonConfiguration extends AbstractRecursiveOperationConfiguration
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RecursiveComparisonConfiguration.Builder
Builder to buildRecursiveComparisonConfiguration
.-
Nested classes/interfaces inherited from class org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration
AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE extends AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE>>
-
-
Field Summary
-
Fields inherited from class org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration
DEFAULT_DELIMITER
-
-
Constructor Summary
Constructors Modifier Constructor Description RecursiveComparisonConfiguration()
private
RecursiveComparisonConfiguration(RecursiveComparisonConfiguration.Builder builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RecursiveComparisonConfiguration.Builder
builder()
Creates builder to buildRecursiveComparisonConfiguration
.java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.util.Comparator<?>>>
comparatorByFields()
(package private) java.util.stream.Stream<java.util.Map.Entry<java.lang.Class<?>,java.util.Comparator<?>>>
comparatorByTypes()
void
compareOnlyFields(java.lang.String... fieldNamesToCompare)
Adds the given fields and their subfields to the set of fields from the object under test to compare (no other fields will be compared).void
compareOnlyFieldsOfTypes(java.lang.Class<?>... typesToCompare)
Adds the given fields of types and their subfields to the set of fields from the object under test to compare (fields of other types will not be compared).private void
describeComparatorForFields(java.lang.StringBuilder description)
private void
describeComparatorForRegexFields(java.lang.StringBuilder description)
private void
describeComparatorForTypes(java.lang.StringBuilder description)
private java.lang.String
describeComparedFields()
private void
describeComparedFields(java.lang.StringBuilder description)
private java.lang.String
describeComparedTypes()
private void
describeComparedTypes(java.lang.StringBuilder description)
private void
describeErrorMessagesForFields(java.lang.StringBuilder description)
private void
describeErrorMessagesForType(java.lang.StringBuilder description)
protected void
describeIgnoreAllActualEmptyOptionalFields(java.lang.StringBuilder description)
protected void
describeIgnoreAllActualNullFields(java.lang.StringBuilder description)
private void
describeIgnoreAllExpectedNullFields(java.lang.StringBuilder description)
private void
describeIgnoreCollectionOrder(java.lang.StringBuilder description)
private java.lang.String
describeIgnoredCollectionOrderInFields()
private void
describeIgnoredCollectionOrderInFields(java.lang.StringBuilder description)
private void
describeIgnoredCollectionOrderInFieldsMatchingRegexes(java.lang.StringBuilder description)
private void
describeIgnoredFieldsForTypes(java.lang.StringBuilder description)
private java.lang.String
describeIgnoredOverriddenEqualsForFields()
private java.lang.String
describeIgnoredOverriddenEqualsForTypes(Representation representation)
private void
describeIgnoredOverriddenEqualsMethods(java.lang.StringBuilder description, Representation representation)
private void
describeIntrospectionStrategy(java.lang.StringBuilder description)
private void
describeOverriddenEqualsMethodsUsage(java.lang.StringBuilder description, Representation representation)
private void
describeRegisteredComparatorByTypes(java.lang.StringBuilder description)
private void
describeRegisteredComparatorForFields(java.lang.StringBuilder description)
private void
describeRegisteredErrorMessagesForFields(java.lang.StringBuilder description)
private void
describeRegisteredErrorMessagesForTypes(java.lang.StringBuilder description)
private void
describeTypeCheckingStrictness(java.lang.StringBuilder description)
private DualValue
dualValueForField(DualValue parentDualValue, java.lang.String fieldName)
boolean
equals(java.lang.Object obj)
private java.lang.String
formatRegisteredComparatorByType(java.util.Map.Entry<java.lang.Class<?>,java.util.Comparator<?>> next)
private java.lang.String
formatRegisteredComparatorForField(java.util.Map.Entry<java.lang.String,java.util.Comparator<?>> comparatorForField)
private java.lang.String
formatRegisteredComparatorForRegexFields(java.util.Map.Entry<java.util.List<java.util.regex.Pattern>,java.util.Comparator<?>> comparatorForRegexFields)
(package private) java.util.Set<java.lang.String>
getActualChildrenNodeNamesToCompare(DualValue dualValue)
(package private) java.util.Set<java.lang.String>
getChildrenNodeNamesOf(java.lang.Object instance)
java.util.Comparator<?>
getComparatorForField(java.lang.String fieldName)
java.util.Comparator<?>
getComparatorForType(java.lang.Class<?> fieldType)
java.util.Set<FieldLocation>
getComparedFields()
Returns the set of fields to compare from the object under test (no other fields will be compared).java.util.Set<java.lang.Class<?>>
getComparedTypes()
Returns the set of type to compare from the object under test (fields of other types will not be compared).FieldComparators
getFieldComparators()
(package private) boolean
getIgnoreAllActualEmptyOptionalFields()
(package private) boolean
getIgnoreAllActualNullFields()
(package private) boolean
getIgnoreAllExpectedNullFields()
(package private) boolean
getIgnoreAllOverriddenEquals()
(package private) boolean
getIgnoreCollectionOrder()
java.util.Set<java.lang.String>
getIgnoredCollectionOrderInFields()
Returns the list fields from the object under test to ignore collection order in the recursive comparison.java.util.List<java.util.regex.Pattern>
getIgnoredCollectionOrderInFieldsMatchingRegexes()
Returns the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison.java.util.List<java.lang.String>
getIgnoredOverriddenEqualsForFields()
java.util.List<java.util.regex.Pattern>
getIgnoredOverriddenEqualsForFieldsMatchingRegexes()
java.util.List<java.lang.Class<?>>
getIgnoredOverriddenEqualsForTypes()
(package private) RecursiveComparisonIntrospectionStrategy
getIntrospectionStrategy()
java.lang.String
getMessageForField(java.lang.String fieldName)
java.lang.String
getMessageForType(java.lang.Class<?> fieldType)
TypeComparators
getTypeComparators()
(package private) java.lang.Object
getValue(java.lang.String name, java.lang.Object instance)
boolean
hasComparatorForField(java.lang.String fieldName)
boolean
hasComparatorForType(java.lang.Class<?> keyType)
(package private) boolean
hasCustomComparator(DualValue dualValue)
boolean
hasCustomComparators()
boolean
hasCustomMessageForField(java.lang.String fieldName)
boolean
hasCustomMessageForType(java.lang.Class<?> fieldType)
int
hashCode()
void
ignoreAllOverriddenEquals()
Force a recursive comparison on all fields (except java types).void
ignoreCollectionOrder(boolean ignoreCollectionOrder)
Sets whether to ignore collection order in the comparison.void
ignoreCollectionOrderInFields(java.lang.String... fieldsToIgnoreCollectionOrder)
Adds the given fields to the list fields from the object under test to ignore collection order in the recursive comparison.void
ignoreCollectionOrderInFieldsMatchingRegexes(java.lang.String... regexes)
Adds the given regexes to the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison.void
ignoreOverriddenEqualsForFields(java.lang.String... fields)
Adds the given fields to the list of fields to force a recursive comparison on.void
ignoreOverriddenEqualsForFieldsMatchingRegexes(java.lang.String... regexes)
Adds the given regexes to the list of regexes used find the fields to force a recursive comparison on.void
ignoreOverriddenEqualsForTypes(java.lang.Class<?>... types)
Adds the given types to the list of types to force a recursive comparison on.private boolean
isConfiguredToIgnoreSomeButNotAllOverriddenEqualsMethods()
boolean
isInStrictTypeCheckingMode()
private boolean
matchesAnIgnoredCollectionOrderInField(FieldLocation fieldLocation)
private boolean
matchesAnIgnoredCollectionOrderInFieldRegex(FieldLocation fieldLocation)
private boolean
matchesAnIgnoredEmptyOptionalField(DualValue dualValue)
private boolean
matchesAnIgnoredFieldType(DualValue dualValue)
private boolean
matchesAnIgnoredNullField(DualValue dualValue)
private boolean
matchesAnIgnoredOverriddenEqualsField(FieldLocation fieldLocation)
private boolean
matchesAnIgnoredOverriddenEqualsRegex(FieldLocation fieldLocation)
private boolean
matchesAnIgnoredOverriddenEqualsType(java.lang.Class<?> clazz)
private static java.util.function.Predicate<FieldLocation>
matchesComparedField(FieldLocation field)
java.lang.String
multiLineDescription(Representation representation)
void
registerComparatorForFields(java.util.Comparator<?> comparator, java.lang.String... fieldLocations)
Registers the givenComparator
to compare the fields at the given locations.<T> void
registerComparatorForType(java.util.Comparator<? super T> comparator, java.lang.Class<T> type)
Registers the givenComparator
to compare the fields with the given type.void
registerEqualsForFields(java.util.function.BiPredicate<?,?> equals, java.lang.String... fieldLocations)
Registers the givenBiPredicate
to compare the fields at the given locations.void
registerEqualsForFieldsMatchingRegexes(java.util.function.BiPredicate<?,?> equals, java.lang.String... regexes)
Allows to register aBiPredicate
to compare fields whose location matches the given regexes.<T> void
registerEqualsForType(java.util.function.BiPredicate<? super T,? super T> equals, java.lang.Class<T> type)
Registers the givenBiPredicate
to compare the fields with the given type.void
registerErrorMessageForFields(java.lang.String message, java.lang.String... fieldLocations)
Registers the giving message which would be shown when differences in the given fields while comparison occurred.void
registerErrorMessageForType(java.lang.String message, java.lang.Class<?> clazz)
Registers the giving message which would be shown when differences for the giving type while comparison occurred.void
setIgnoreAllActualEmptyOptionalFields(boolean ignoringAllActualEmptyOptionalFields)
Sets whether actual empty optional fields are ignored in the recursive comparison.void
setIgnoreAllActualNullFields(boolean ignoreAllActualNullFields)
Sets whether actual null fields are ignored in the recursive comparison.void
setIgnoreAllExpectedNullFields(boolean ignoreAllExpectedNullFields)
Sets whether expected null fields are ignored in the recursive comparison.void
setIntrospectionStrategy(RecursiveComparisonIntrospectionStrategy introspectionStrategy)
Defines how objects are introspected in the recursive comparison.private boolean
shouldBeCompared(DualValue dualValue)
private boolean
shouldBeComparedBasedOnFieldLocation(FieldLocation fieldLocation)
private boolean
shouldBeComparedBasedOnFieldValue(DualValue dualValue)
(package private) boolean
shouldIgnore(DualValue dualValue)
(package private) boolean
shouldIgnoreCollectionOrder(FieldLocation fieldLocation)
private boolean
shouldIgnoreFieldBasedOnFieldLocation(FieldLocation fieldLocation)
private boolean
shouldIgnoreFieldBasedOnFieldValue(DualValue dualValue)
(package private) boolean
shouldIgnoreOverriddenEqualsOf(java.lang.Class<?> clazz)
(package private) boolean
shouldIgnoreOverriddenEqualsOf(DualValue dualValue)
void
strictTypeChecking(boolean strictTypeChecking)
Sets whether the recursive comparison will check that actual's type is compatible with expected's type (the same applies for each field).private static java.util.Comparator
toComparator(java.util.function.BiPredicate equals)
java.lang.String
toString()
void
useOverriddenEquals()
Force a recursive comparison on all fields (except java types).-
Methods inherited from class org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration
asWrapperIfPrimitiveType, describeIgnoredFields, describeIgnoredFieldsRegexes, describeIgnoredTypes, describeRegexes, getIgnoredFields, getIgnoredFieldsRegexes, getIgnoredTypes, ignoreFields, ignoreFieldsMatchingRegexes, ignoreFieldsOfTypes, join, matchesAnIgnoredField, matchesAnIgnoredFieldRegex
-
-
-
-
Field Detail
-
DEFAULT_IGNORE_ALL_OVERRIDDEN_EQUALS
private static final boolean DEFAULT_IGNORE_ALL_OVERRIDDEN_EQUALS
- See Also:
- Constant Field Values
-
INDENT_LEVEL_2
public static final java.lang.String INDENT_LEVEL_2
- See Also:
- Constant Field Values
-
DEFAULT_RECURSIVE_COMPARISON_INTROSPECTION_STRATEGY
public static final DefaultRecursiveComparisonIntrospectionStrategy DEFAULT_RECURSIVE_COMPARISON_INTROSPECTION_STRATEGY
-
strictTypeChecking
private boolean strictTypeChecking
-
ignoreAllActualNullFields
private boolean ignoreAllActualNullFields
-
ignoreAllActualEmptyOptionalFields
private boolean ignoreAllActualEmptyOptionalFields
-
ignoreAllExpectedNullFields
private boolean ignoreAllExpectedNullFields
-
comparedFields
private java.util.Set<FieldLocation> comparedFields
-
comparedTypes
private java.util.Set<java.lang.Class<?>> comparedTypes
-
ignoredOverriddenEqualsForTypes
private final java.util.List<java.lang.Class<?>> ignoredOverriddenEqualsForTypes
-
ignoredOverriddenEqualsForFields
private java.util.List<java.lang.String> ignoredOverriddenEqualsForFields
-
ignoredOverriddenEqualsForFieldsMatchingRegexes
private final java.util.List<java.util.regex.Pattern> ignoredOverriddenEqualsForFieldsMatchingRegexes
-
ignoreAllOverriddenEquals
private boolean ignoreAllOverriddenEquals
-
ignoreCollectionOrder
private boolean ignoreCollectionOrder
-
ignoredCollectionOrderInFields
private java.util.Set<java.lang.String> ignoredCollectionOrderInFields
-
ignoredCollectionOrderInFieldsMatchingRegexes
private final java.util.List<java.util.regex.Pattern> ignoredCollectionOrderInFieldsMatchingRegexes
-
typeComparators
private TypeComparators typeComparators
-
fieldComparators
private FieldComparators fieldComparators
-
typeMessages
private TypeMessages typeMessages
-
fieldMessages
private FieldMessages fieldMessages
-
fieldLocationOfFieldsOfTypesToCompare
private final java.util.Set<FieldLocation> fieldLocationOfFieldsOfTypesToCompare
-
introspectionStrategy
private RecursiveComparisonIntrospectionStrategy introspectionStrategy
-
-
Constructor Detail
-
RecursiveComparisonConfiguration
private RecursiveComparisonConfiguration(RecursiveComparisonConfiguration.Builder builder)
-
RecursiveComparisonConfiguration
public RecursiveComparisonConfiguration()
-
-
Method Detail
-
hasComparatorForField
public boolean hasComparatorForField(java.lang.String fieldName)
-
getComparatorForField
public java.util.Comparator<?> getComparatorForField(java.lang.String fieldName)
-
hasCustomMessageForField
public boolean hasCustomMessageForField(java.lang.String fieldName)
-
getMessageForField
public java.lang.String getMessageForField(java.lang.String fieldName)
-
getFieldComparators
public FieldComparators getFieldComparators()
-
hasComparatorForType
public boolean hasComparatorForType(java.lang.Class<?> keyType)
-
hasCustomComparators
public boolean hasCustomComparators()
-
getComparatorForType
public java.util.Comparator<?> getComparatorForType(java.lang.Class<?> fieldType)
-
hasCustomMessageForType
public boolean hasCustomMessageForType(java.lang.Class<?> fieldType)
-
getMessageForType
public java.lang.String getMessageForType(java.lang.Class<?> fieldType)
-
getTypeComparators
public TypeComparators getTypeComparators()
-
comparatorByTypes
java.util.stream.Stream<java.util.Map.Entry<java.lang.Class<?>,java.util.Comparator<?>>> comparatorByTypes()
-
getIgnoreAllActualNullFields
boolean getIgnoreAllActualNullFields()
-
getIgnoreAllExpectedNullFields
boolean getIgnoreAllExpectedNullFields()
-
getIgnoreAllOverriddenEquals
boolean getIgnoreAllOverriddenEquals()
-
setIgnoreAllActualEmptyOptionalFields
public void setIgnoreAllActualEmptyOptionalFields(boolean ignoringAllActualEmptyOptionalFields)
Sets whether actual empty optional fields are ignored in the recursive comparison.See
RecursiveComparisonAssert.ignoringActualNullFields()
for code examples.- Parameters:
ignoringAllActualEmptyOptionalFields
- whether to ignore actual empty optional fields in the recursive comparison
-
getIgnoreAllActualEmptyOptionalFields
boolean getIgnoreAllActualEmptyOptionalFields()
-
setIgnoreAllActualNullFields
public void setIgnoreAllActualNullFields(boolean ignoreAllActualNullFields)
Sets whether actual null fields are ignored in the recursive comparison.See
RecursiveComparisonAssert.ignoringActualNullFields()
for code examples.- Parameters:
ignoreAllActualNullFields
- whether to ignore actual null fields in the recursive comparison
-
setIgnoreAllExpectedNullFields
public void setIgnoreAllExpectedNullFields(boolean ignoreAllExpectedNullFields)
Sets whether expected null fields are ignored in the recursive comparison.See
RecursiveComparisonAssert.ignoringExpectedNullFields()
for code examples.- Parameters:
ignoreAllExpectedNullFields
- whether to ignore expected null fields in the recursive comparison
-
compareOnlyFields
public void compareOnlyFields(java.lang.String... fieldNamesToCompare)
Adds the given fields and their subfields to the set of fields from the object under test to compare (no other fields will be compared).The fields are specified by name, not by value, you can specify
person.name
but not"Jack"
as"Jack"
is not a field value.Specifying a field will make all its subfields to be compared, for example specifying
person
will lead to compareperson.name
,person.address
... on the other hand if you specifyperson.name
,person
won't be compared butperson.name
will be.See
RecursiveComparisonAssert#comparingOnlyFields(String...)
for examples.- Parameters:
fieldNamesToCompare
- the fields of the object under test to compare in the comparison.
-
compareOnlyFieldsOfTypes
public void compareOnlyFieldsOfTypes(java.lang.Class<?>... typesToCompare)
Adds the given fields of types and their subfields to the set of fields from the object under test to compare (fields of other types will not be compared).Specifying a field of type will make all its subfields to be compared, for example specifying
Person
will lead to comparePerson.name
,Person.address
...See
RecursiveComparisonAssert#comparingOnlyFieldsOfTypes(Class...)
for examples.- Parameters:
typesToCompare
- the types to compare in the recursive comparison.
-
getComparedFields
public java.util.Set<FieldLocation> getComparedFields()
Returns the set of fields to compare from the object under test (no other fields will be compared).- Returns:
- the set of fields from the object under test to compare.
-
getComparedTypes
public java.util.Set<java.lang.Class<?>> getComparedTypes()
Returns the set of type to compare from the object under test (fields of other types will not be compared).- Returns:
- the set of types from the object under test to compare.
-
ignoreAllOverriddenEquals
public void ignoreAllOverriddenEquals()
Force a recursive comparison on all fields (except java types).See
RecursiveComparisonAssert.ignoringAllOverriddenEquals()
for examples.
-
useOverriddenEquals
public void useOverriddenEquals()
Force a recursive comparison on all fields (except java types).See
RecursiveComparisonAssert.usingOverriddenEquals()
for examples.
-
ignoreOverriddenEqualsForFields
public void ignoreOverriddenEqualsForFields(java.lang.String... fields)
Adds the given fields to the list of fields to force a recursive comparison on.See
RecursiveComparisonAssert#ignoringOverriddenEqualsForFields(String...)
for examples.- Parameters:
fields
- the fields to force a recursive comparison on.
-
ignoreOverriddenEqualsForFieldsMatchingRegexes
public void ignoreOverriddenEqualsForFieldsMatchingRegexes(java.lang.String... regexes)
Adds the given regexes to the list of regexes used find the fields to force a recursive comparison on.See
RecursiveComparisonAssert#ignoringOverriddenEqualsForFieldsMatchingRegexes(String...)
for examples.- Parameters:
regexes
- regexes used to specify the fields we want to force a recursive comparison on.
-
ignoreOverriddenEqualsForTypes
public void ignoreOverriddenEqualsForTypes(java.lang.Class<?>... types)
Adds the given types to the list of types to force a recursive comparison on.See
RecursiveComparisonAssert#ignoringOverriddenEqualsForTypes(Class...)
for examples.- Parameters:
types
- the types to the list of types to force a recursive comparison on.
-
getIgnoreCollectionOrder
boolean getIgnoreCollectionOrder()
-
ignoreCollectionOrder
public void ignoreCollectionOrder(boolean ignoreCollectionOrder)
Sets whether to ignore collection order in the comparison.See
RecursiveComparisonAssert.ignoringCollectionOrder()
for code examples.- Parameters:
ignoreCollectionOrder
- whether to ignore collection order in the comparison.
-
ignoreCollectionOrderInFields
public void ignoreCollectionOrderInFields(java.lang.String... fieldsToIgnoreCollectionOrder)
Adds the given fields to the list fields from the object under test to ignore collection order in the recursive comparison.See
RecursiveComparisonAssert#ignoringCollectionOrderInFields(String...)
for examples.- Parameters:
fieldsToIgnoreCollectionOrder
- the fields of the object under test to ignore collection order in the comparison.
-
getIgnoredCollectionOrderInFields
public java.util.Set<java.lang.String> getIgnoredCollectionOrderInFields()
Returns the list fields from the object under test to ignore collection order in the recursive comparison.- Returns:
- the list fields from the object under test to ignore collection order in the recursive comparison.
-
ignoreCollectionOrderInFieldsMatchingRegexes
public void ignoreCollectionOrderInFieldsMatchingRegexes(java.lang.String... regexes)
Adds the given regexes to the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison.See
RecursiveComparisonAssert#ignoringCollectionOrderInFieldsMatchingRegexes(String...)
for examples.- Parameters:
regexes
- regexes used to find the object under test fields to ignore collection order in the comparison.
-
getIgnoredCollectionOrderInFieldsMatchingRegexes
public java.util.List<java.util.regex.Pattern> getIgnoredCollectionOrderInFieldsMatchingRegexes()
Returns the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison.- Returns:
- the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison.
-
registerComparatorForType
public <T> void registerComparatorForType(java.util.Comparator<? super T> comparator, java.lang.Class<T> type)
Registers the givenComparator
to compare the fields with the given type.Comparators registered with this method have less precedence than comparators registered with
registerComparatorForFields(Comparator, String...)
.Note that registering a
Comparator
for a given type will override the previously registered BiPredicate/Comparator (if any).See
RecursiveComparisonAssert.withComparatorForType(Comparator, Class)
for examples.- Type Parameters:
T
- the class type to register a comparator for- Parameters:
comparator
- theComparator
to use to compare the given typetype
- the type to be compared with the given comparator.- Throws:
java.lang.NullPointerException
- if the given comparator is null.
-
registerEqualsForType
public <T> void registerEqualsForType(java.util.function.BiPredicate<? super T,? super T> equals, java.lang.Class<T> type)
Registers the givenBiPredicate
to compare the fields with the given type.BiPredicates specified with this method have less precedence than the ones registered with
registerEqualsForFields(BiPredicate, String...)
or comparators registered withregisterComparatorForFields(Comparator, String...)
.Note that registering a
BiPredicate
for a given type will override the previously registered BiPredicate/Comparator (if any).See
RecursiveComparisonAssert.withEqualsForType(BiPredicate, Class)
for examples.- Type Parameters:
T
- the class type to register a comparator for- Parameters:
equals
- the equals implementation to compare the given typetype
- the type to be compared with the given equals implementation .- Throws:
java.lang.NullPointerException
- if the given BiPredicate is null.- Since:
- 3.17.0
-
registerComparatorForFields
public void registerComparatorForFields(java.util.Comparator<?> comparator, java.lang.String... fieldLocations)
Registers the givenComparator
to compare the fields at the given locations.The fields must be specified from the root object, for example if
Foo
has aBar
field and both have anid
field, one can register a comparator for Foo and Bar'sid
by calling:registerComparatorForFields(idComparator, "foo.id", "foo.bar.id")
Comparators registered with this method have precedence over comparators registered with
registerComparatorForType(Comparator, Class)
.Note that registering a
Comparator
for a given field will override the previously registered BiPredicate/Comparator (if any).See
RecursiveComparisonAssert#withComparatorForFields(Comparator, String...)
for examples.- Parameters:
comparator
- theComparator
to use to compare the given fieldfieldLocations
- the locations from the root object of the fields the comparator should be used for- Throws:
java.lang.NullPointerException
- if the given comparator is null.
-
registerEqualsForFields
public void registerEqualsForFields(java.util.function.BiPredicate<?,?> equals, java.lang.String... fieldLocations)
Registers the givenBiPredicate
to compare the fields at the given locations.The fields must be specified from the root object, for example if
Foo
has aBar
field and both have anid
field, one can register a BiPredicate for Foo and Bar'sid
by calling:registerEqualsForFields(idBiPredicate, "foo.id", "foo.bar.id")
BiPredicates registered with this method have precedence over the ones registered with
registerEqualsForType(BiPredicate, Class)
or the comparators registered withregisterComparatorForType(Comparator, Class)
.Note that registering a
BiPredicate
for a given field will override the previously registered BiPredicate/Comparator (if any).See
RecursiveComparisonAssert#withEqualsForFields(BiPredicate, String...)
for examples.- Parameters:
equals
- the equals implementation to compare the given fields.fieldLocations
- the locations from the root object of the fields the comparator should be used for- Throws:
java.lang.NullPointerException
- if the given BiPredicate is null.- Since:
- 3.17.0
-
registerEqualsForFieldsMatchingRegexes
public void registerEqualsForFieldsMatchingRegexes(java.util.function.BiPredicate<?,?> equals, java.lang.String... regexes)
Allows to register aBiPredicate
to compare fields whose location matches the given regexes. A typical usage is to compare double/float fields with a given precision.The fields are evaluated from the root object, for example if
Foo
has aBar
field and both have anid
field, one can register a BiPredicate for Foo and Bar'sid
by calling:
orregisterEqualsForFieldsMatchingRegexes(idBiPredicate, ".*id")
registerEqualsForFieldsMatchingRegexes(idBiPredicate, "foo.*id")
BiPredicates registered with this method have precedence over the ones registered with
registerEqualsForType(BiPredicate, Class)
or the comparators registered withregisterComparatorForType(Comparator, Class)
but don't have precedence over the ones registered with exact location match:registerEqualsForFields(BiPredicate, String...)
orregisterComparatorForFields(Comparator, String...)
If registered regexes for different
BiPredicate
match a given field, the latest registered regexesBiPredicate
wins.Example: see
RecursiveComparisonAssert.withEqualsForFieldsMatchingRegexes(BiPredicate, String...)
- Parameters:
equals
- theBiPredicate
to use to compare the fields matching the given regexesregexes
- the regexes from the root object of the fields location the BiPredicate should be used for- Throws:
java.lang.NullPointerException
- if the given BiPredicate is null.- Since:
- 3.24.0
-
registerErrorMessageForFields
public void registerErrorMessageForFields(java.lang.String message, java.lang.String... fieldLocations)
Registers the giving message which would be shown when differences in the given fields while comparison occurred.The fields must be specified from the root object, for example if
Foo
has aBar
field and both have anid
field, one can register a message for Foo and Bar'sid
by calling:registerErrorMessageForFields("some message", "foo.id", "foo.bar.id")
Messages registered with this method have precedence over the ones registered with
registerErrorMessageForType(String, Class)
.In case of
null
as message the default error message will be used (SeeComparisonDifference.DEFAULT_TEMPLATE
).- Parameters:
message
- the error message that will be thrown when comparison error occurredfieldLocations
- the field locations the error message should be used for
-
registerErrorMessageForType
public void registerErrorMessageForType(java.lang.String message, java.lang.Class<?> clazz)
Registers the giving message which would be shown when differences for the giving type while comparison occurred.Message registered with this method have less precedence than the ones registered with
registerErrorMessageForFields(String, String...)
.In case of
null
as message the default error message will be used (SeeComparisonDifference.DEFAULT_TEMPLATE
).- Parameters:
message
- the error message that will be thrown when comparison error occurredclazz
- the type the error message should be used for
-
strictTypeChecking
public void strictTypeChecking(boolean strictTypeChecking)
Sets whether the recursive comparison will check that actual's type is compatible with expected's type (the same applies for each field). Compatible means that the expected's type is the same or a subclass of actual's type.See
RecursiveComparisonAssert.withStrictTypeChecking()
for code examples.- Parameters:
strictTypeChecking
- whether the recursive comparison will check that actual's type is compatible with expected's type.
-
isInStrictTypeCheckingMode
public boolean isInStrictTypeCheckingMode()
-
getIgnoredOverriddenEqualsForTypes
public java.util.List<java.lang.Class<?>> getIgnoredOverriddenEqualsForTypes()
-
getIgnoredOverriddenEqualsForFields
public java.util.List<java.lang.String> getIgnoredOverriddenEqualsForFields()
-
getIgnoredOverriddenEqualsForFieldsMatchingRegexes
public java.util.List<java.util.regex.Pattern> getIgnoredOverriddenEqualsForFieldsMatchingRegexes()
-
comparatorByFields
public java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.util.Comparator<?>>> comparatorByFields()
-
getIntrospectionStrategy
RecursiveComparisonIntrospectionStrategy getIntrospectionStrategy()
-
setIntrospectionStrategy
public void setIntrospectionStrategy(RecursiveComparisonIntrospectionStrategy introspectionStrategy)
Defines how objects are introspected in the recursive comparison.Default to
DefaultRecursiveComparisonIntrospectionStrategy
.- Parameters:
introspectionStrategy
- theRecursiveComparisonIntrospectionStrategy
to use
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
multiLineDescription
public java.lang.String multiLineDescription(Representation representation)
-
shouldIgnore
boolean shouldIgnore(DualValue dualValue)
-
shouldBeCompared
private boolean shouldBeCompared(DualValue dualValue)
-
shouldBeComparedBasedOnFieldLocation
private boolean shouldBeComparedBasedOnFieldLocation(FieldLocation fieldLocation)
-
matchesComparedField
private static java.util.function.Predicate<FieldLocation> matchesComparedField(FieldLocation field)
-
getActualChildrenNodeNamesToCompare
java.util.Set<java.lang.String> getActualChildrenNodeNamesToCompare(DualValue dualValue)
-
getChildrenNodeNamesOf
java.util.Set<java.lang.String> getChildrenNodeNamesOf(java.lang.Object instance)
-
getValue
java.lang.Object getValue(java.lang.String name, java.lang.Object instance)
-
shouldIgnoreFieldBasedOnFieldValue
private boolean shouldIgnoreFieldBasedOnFieldValue(DualValue dualValue)
-
shouldIgnoreFieldBasedOnFieldLocation
private boolean shouldIgnoreFieldBasedOnFieldLocation(FieldLocation fieldLocation)
-
dualValueForField
private DualValue dualValueForField(DualValue parentDualValue, java.lang.String fieldName)
-
hasCustomComparator
boolean hasCustomComparator(DualValue dualValue)
-
shouldIgnoreOverriddenEqualsOf
boolean shouldIgnoreOverriddenEqualsOf(DualValue dualValue)
-
shouldIgnoreOverriddenEqualsOf
boolean shouldIgnoreOverriddenEqualsOf(java.lang.Class<?> clazz)
-
shouldIgnoreCollectionOrder
boolean shouldIgnoreCollectionOrder(FieldLocation fieldLocation)
-
describeComparedFields
private void describeComparedFields(java.lang.StringBuilder description)
-
describeComparedTypes
private void describeComparedTypes(java.lang.StringBuilder description)
-
describeIgnoredFieldsForTypes
private void describeIgnoredFieldsForTypes(java.lang.StringBuilder description)
-
describeIgnoreAllActualNullFields
protected void describeIgnoreAllActualNullFields(java.lang.StringBuilder description)
-
describeIgnoreAllActualEmptyOptionalFields
protected void describeIgnoreAllActualEmptyOptionalFields(java.lang.StringBuilder description)
-
describeIgnoreAllExpectedNullFields
private void describeIgnoreAllExpectedNullFields(java.lang.StringBuilder description)
-
describeOverriddenEqualsMethodsUsage
private void describeOverriddenEqualsMethodsUsage(java.lang.StringBuilder description, Representation representation)
-
describeIgnoredOverriddenEqualsMethods
private void describeIgnoredOverriddenEqualsMethods(java.lang.StringBuilder description, Representation representation)
-
describeIgnoredOverriddenEqualsForTypes
private java.lang.String describeIgnoredOverriddenEqualsForTypes(Representation representation)
-
describeIgnoredOverriddenEqualsForFields
private java.lang.String describeIgnoredOverriddenEqualsForFields()
-
describeIgnoreCollectionOrder
private void describeIgnoreCollectionOrder(java.lang.StringBuilder description)
-
describeIgnoredCollectionOrderInFields
private void describeIgnoredCollectionOrderInFields(java.lang.StringBuilder description)
-
describeIgnoredCollectionOrderInFieldsMatchingRegexes
private void describeIgnoredCollectionOrderInFieldsMatchingRegexes(java.lang.StringBuilder description)
-
describeIntrospectionStrategy
private void describeIntrospectionStrategy(java.lang.StringBuilder description)
-
matchesAnIgnoredOverriddenEqualsRegex
private boolean matchesAnIgnoredOverriddenEqualsRegex(FieldLocation fieldLocation)
-
matchesAnIgnoredOverriddenEqualsType
private boolean matchesAnIgnoredOverriddenEqualsType(java.lang.Class<?> clazz)
-
matchesAnIgnoredOverriddenEqualsField
private boolean matchesAnIgnoredOverriddenEqualsField(FieldLocation fieldLocation)
-
matchesAnIgnoredNullField
private boolean matchesAnIgnoredNullField(DualValue dualValue)
-
matchesAnIgnoredEmptyOptionalField
private boolean matchesAnIgnoredEmptyOptionalField(DualValue dualValue)
-
matchesAnIgnoredFieldType
private boolean matchesAnIgnoredFieldType(DualValue dualValue)
-
shouldBeComparedBasedOnFieldValue
private boolean shouldBeComparedBasedOnFieldValue(DualValue dualValue)
-
matchesAnIgnoredCollectionOrderInField
private boolean matchesAnIgnoredCollectionOrderInField(FieldLocation fieldLocation)
-
matchesAnIgnoredCollectionOrderInFieldRegex
private boolean matchesAnIgnoredCollectionOrderInFieldRegex(FieldLocation fieldLocation)
-
describeComparedFields
private java.lang.String describeComparedFields()
-
describeComparedTypes
private java.lang.String describeComparedTypes()
-
describeIgnoredCollectionOrderInFields
private java.lang.String describeIgnoredCollectionOrderInFields()
-
isConfiguredToIgnoreSomeButNotAllOverriddenEqualsMethods
private boolean isConfiguredToIgnoreSomeButNotAllOverriddenEqualsMethods()
-
describeRegisteredComparatorByTypes
private void describeRegisteredComparatorByTypes(java.lang.StringBuilder description)
-
describeComparatorForTypes
private void describeComparatorForTypes(java.lang.StringBuilder description)
-
formatRegisteredComparatorByType
private java.lang.String formatRegisteredComparatorByType(java.util.Map.Entry<java.lang.Class<?>,java.util.Comparator<?>> next)
-
describeRegisteredComparatorForFields
private void describeRegisteredComparatorForFields(java.lang.StringBuilder description)
-
describeComparatorForFields
private void describeComparatorForFields(java.lang.StringBuilder description)
-
describeComparatorForRegexFields
private void describeComparatorForRegexFields(java.lang.StringBuilder description)
-
formatRegisteredComparatorForField
private java.lang.String formatRegisteredComparatorForField(java.util.Map.Entry<java.lang.String,java.util.Comparator<?>> comparatorForField)
-
formatRegisteredComparatorForRegexFields
private java.lang.String formatRegisteredComparatorForRegexFields(java.util.Map.Entry<java.util.List<java.util.regex.Pattern>,java.util.Comparator<?>> comparatorForRegexFields)
-
describeTypeCheckingStrictness
private void describeTypeCheckingStrictness(java.lang.StringBuilder description)
-
describeRegisteredErrorMessagesForFields
private void describeRegisteredErrorMessagesForFields(java.lang.StringBuilder description)
-
describeErrorMessagesForFields
private void describeErrorMessagesForFields(java.lang.StringBuilder description)
-
describeRegisteredErrorMessagesForTypes
private void describeRegisteredErrorMessagesForTypes(java.lang.StringBuilder description)
-
describeErrorMessagesForType
private void describeErrorMessagesForType(java.lang.StringBuilder description)
-
builder
public static RecursiveComparisonConfiguration.Builder builder()
Creates builder to buildRecursiveComparisonConfiguration
.- Returns:
- created builder
-
toComparator
private static java.util.Comparator toComparator(java.util.function.BiPredicate equals)
-
-