AssertJ Core 3.26.0 · org.assertj.core.api.recursive.comparison.RecursiveComparisonConfiguration

Modifier and Type	Class and Description
public static class	RecursiveComparisonConfiguration.Builder Builder to build `RecursiveComparisonConfiguration`.

Modifier and Type	Field and Description
private Set<FieldLocation>	comparedFields
private Set<Class<?>>	comparedTypes
private boolean	compareEnumAgainstString
private static final boolean	DEFAULT_IGNORE_ALL_OVERRIDDEN_EQUALS
public static final DefaultRecursiveComparisonIntrospectionStrategy	DEFAULT_RECURSIVE_COMPARISON_INTROSPECTION_STRATEGY
private FieldComparators	fieldComparators
private final Set<FieldLocation>	fieldLocationsToCompareBecauseOfTypesToCompare
private FieldMessages	fieldMessages
private boolean	ignoreAllActualEmptyOptionalFields
private boolean	ignoreAllActualNullFields
private boolean	ignoreAllExpectedNullFields
private boolean	ignoreAllOverriddenEquals
private boolean	ignoreCollectionOrder
private Set<String>	ignoredCollectionOrderInFields
private final List<Pattern>	ignoredCollectionOrderInFieldsMatchingRegexes
private List<String>	ignoredOverriddenEqualsForFields
private final List<Pattern>	ignoredOverriddenEqualsForFieldsMatchingRegexes
private final List<Class<?>>	ignoredOverriddenEqualsForTypes
public static final String	INDENT_LEVEL_2
private RecursiveComparisonIntrospectionStrategy	introspectionStrategy
private boolean	strictTypeChecking
private TypeComparators	typeComparators
private TypeMessages	typeMessages

Access	Constructor and Description
private	RecursiveComparisonConfiguration(RecursiveComparisonConfiguration.Builder builder)
public	RecursiveComparisonConfiguration()

Method Summary

Modifier and Type	Method and Description
public void	allowComparingEnumAgainstString(boolean whether to allow the recursive comparison to compare enum field against string field. compareEnumAgainstString) Allows the recursive comparison to compare an enum field against a string field.
public static RecursiveComparisonConfiguration.Builder	Returns: created builder builder() Creates builder to build `RecursiveComparisonConfiguration`.
private Optional<Map.Entry<FieldLocation, String>>	checkComparedFieldExists(Object actual, FieldLocation comparedFieldLocation)
pack-priv void	checkComparedFieldsExist(Object actual)
public Stream<Map.Entry<String, Comparator<?>>>	comparatorByFields()
pack-priv Stream<Map.Entry<Class<?>, Comparator<?>>>	comparatorByTypes()
public void	compareOnlyFields(String... the fields of the object under test to compare in the comparison. 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).
public void	compareOnlyFieldsOfTypes(Class<?>... the types to compare in the recursive comparison. 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(StringBuilder description)
private void	describeComparatorForRegexFields(StringBuilder description)
private void	describeComparatorForTypes(StringBuilder description)
private void	describeComparedFields(StringBuilder description)
private String	describeComparedFields()
private void	describeComparedTypes(StringBuilder description)
private String	describeComparedTypes()
private void	describeCompareEnumAgainstString(StringBuilder description)
private void	describeErrorMessagesForFields(StringBuilder description)
private void	describeErrorMessagesForType(StringBuilder description)
protected void	describeIgnoreAllActualEmptyOptionalFields(StringBuilder description)
protected void	describeIgnoreAllActualNullFields(StringBuilder description)
private void	describeIgnoreAllExpectedNullFields(StringBuilder description)
private void	describeIgnoreCollectionOrder(StringBuilder description)
private void	describeIgnoredCollectionOrderInFields(StringBuilder description)
private String	describeIgnoredCollectionOrderInFields()
private void	describeIgnoredCollectionOrderInFieldsMatchingRegexes(StringBuilder description)
private String	describeIgnoredOverriddenEqualsForFields()
private String	describeIgnoredOverriddenEqualsForTypes(Representation representation)
private void	describeIgnoredOverriddenEqualsMethods(StringBuilder description, Representation representation)
private void	describeIgnoredTypes(StringBuilder description)
private void	describeIgnoredTypesRegexes(StringBuilder description)
private void	describeIntrospectionStrategy(StringBuilder description)
private void	describeOverriddenEqualsMethodsUsage(StringBuilder description, Representation representation)
private void	describeRegisteredComparatorByTypes(StringBuilder description)
private void	describeRegisteredComparatorForFields(StringBuilder description)
private void	describeRegisteredErrorMessagesForFields(StringBuilder description)
private void	describeRegisteredErrorMessagesForTypes(StringBuilder description)
private void	describeTypeCheckingStrictness(StringBuilder description)
private DualValue	dualValueForField(DualValue parentDualValue, String fieldName)
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv boolean	exactlyMatchesAnyComparedFields(DualValue dualValue)
private String	formatRegisteredComparatorByType(Map.Entry<Class<?>, Comparator<?>> next)
private String	formatRegisteredComparatorForField(Map.Entry<String, Comparator<?>> comparatorForField)
private String	formatRegisteredComparatorForRegexFields(Map.Entry<List<Pattern>, Comparator<?>> comparatorForRegexFields)
private static String	formatUnknownComparedField(FieldLocation fieldLocation, String unknownNodeNameElement)
pack-priv Set<String>	getActualChildrenNodeNamesToCompare(DualValue dualValue)
pack-priv Set<String>	getChildrenNodeNamesOf(Object instance)
public Comparator<?>	getComparatorForField(String fieldName)
public Comparator<?>	getComparatorForType(Class<?> fieldType)
public Set<FieldLocation>	Returns: the set of fields from the object under test to compare. getComparedFields() Returns the set of fields to compare from the object under test (no other fields will be compared).
public Set<Class<?>>	Returns: the set of types from the object under test to compare. getComparedTypes() Returns the set of type to compare from the object under test (fields of other types will not be compared).
public FieldComparators	getFieldComparators()
pack-priv boolean	getIgnoreAllActualEmptyOptionalFields()
pack-priv boolean	getIgnoreAllActualNullFields()
pack-priv boolean	getIgnoreAllExpectedNullFields()
pack-priv boolean	getIgnoreAllOverriddenEquals()
pack-priv boolean	getIgnoreCollectionOrder()
public Set<String>	Returns: the list fields from the object under test to ignore collection order in the recursive comparison. getIgnoredCollectionOrderInFields() Returns the list fields from the object under test to ignore collection order in the recursive comparison.
public List<Pattern>	Returns: the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison. getIgnoredCollectionOrderInFieldsMatchingRegexes() Returns the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison.
public List<String>	getIgnoredOverriddenEqualsForFields()
public List<Pattern>	getIgnoredOverriddenEqualsForFieldsMatchingRegexes()
public List<Class<?>>	getIgnoredOverriddenEqualsForTypes()
pack-priv RecursiveComparisonIntrospectionStrategy	getIntrospectionStrategy()
public String	getMessageForField(String fieldName)
public String	getMessageForType(Class<?> fieldType)
public TypeComparators	getTypeComparators()
pack-priv Object	getValue(String name, Object instance)
public boolean	hasComparatorForField(String fieldName)
public boolean	hasComparatorForType(Class<?> keyType)
pack-priv boolean	hasComparedTypes()
pack-priv boolean	hasCustomComparator(DualValue dualValue)
public boolean	hasCustomComparators()
public boolean	hasCustomMessageForField(String fieldName)
public boolean	hasCustomMessageForType(Class<?> fieldType)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv boolean	hierarchyMatchesAnyComparedTypes(DualValue dualValue)
public void	ignoreAllOverriddenEquals() Force a recursive comparison on all fields (except java types).
public void	ignoreCollectionOrder(boolean whether to ignore collection order in the comparison. ignoreCollectionOrder) Sets whether to ignore collection order in the comparison.
public void	ignoreCollectionOrderInFields(String... the fields of the object under test to ignore collection order in the comparison. fieldsToIgnoreCollectionOrder) Adds the given fields to the list fields from the object under test to ignore collection order in the recursive comparison.
public void	ignoreCollectionOrderInFieldsMatchingRegexes(String... regexes used to find the object under test fields to ignore collection order in the comparison. 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.
public void	ignoreOverriddenEqualsForFields(String... the fields to force a recursive comparison on. fields) Adds the given fields to the list of fields to force a recursive comparison on.
public void	ignoreOverriddenEqualsForFieldsMatchingRegexes(String... regexes used to specify the fields we want to force a recursive comparison on. regexes) Adds the given regexes to the list of regexes used find the fields to force a recursive comparison on.
public void	ignoreOverriddenEqualsForTypes(Class<?>... the types to the list of types to force a recursive comparison on. types) Adds the given types to the list of types to force a recursive comparison on.
public boolean	isComparingEnumAgainstStringAllowed()
private boolean	isConfiguredToIgnoreSomeButNotAllOverriddenEqualsMethods()
private boolean	isFieldOfTypeToCompare(DualValue dualValue)
public boolean	isInStrictTypeCheckingMode()
pack-priv boolean	isOrIsChildOfAnyComparedFields(FieldLocation currentFieldLocation)
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(DualValue dualValue)
private boolean	matchesAnIgnoredOverriddenEqualsRegex(FieldLocation fieldLocation)
private boolean	matchesAnIgnoredOverriddenEqualsType(Class<?> clazz)
private boolean	matchesAnIgnoredType(Object actual)
private static Predicate<FieldLocation>	matchesComparedField(FieldLocation field)
pack-priv boolean	matchesOrIsChildOfFieldMatchingAnyComparedTypes(DualValue dualValue)
public String	multiLineDescription(Representation representation)
public void	registerComparatorForFields(Comparator<?> the `Comparator` to use to compare the given field comparator, String... the locations from the root object of the fields the comparator should be used for fieldLocations) Registers the given `Comparator` to compare the fields at the given locations.
public < the class type to register a comparator for T> void	registerComparatorForType(Comparator<? super T> the `Comparator` to use to compare the given type comparator, Class<T> the type to be compared with the given comparator. type) Registers the given `Comparator` to compare the fields with the given type.
public void	registerEqualsForFields(BiPredicate<?, ?> the equals implementation to compare the given fields. equals, String... the locations from the root object of the fields the comparator should be used for fieldLocations) Registers the given `BiPredicate` to compare the fields at the given locations.
public void	registerEqualsForFieldsMatchingRegexes(BiPredicate<?, ?> the `BiPredicate` to use to compare the fields matching the given regexes equals, String... the regexes from the root object of the fields location the BiPredicate should be used for regexes) Allows to register a `BiPredicate` to compare fields whose location matches the given regexes.
public < the class type to register a comparator for T> void	registerEqualsForType(BiPredicate<? super T, ? super T> the equals implementation to compare the given type equals, Class<T> the type to be compared with the given equals implementation . type) Registers the given `BiPredicate` to compare the fields with the given type.
public void	registerErrorMessageForFields(String the error message that will be thrown when comparison error occurred message, String... the field locations the error message should be used for fieldLocations) Registers the giving message which would be shown when differences in the given fields while comparison occurred.
public void	registerErrorMessageForType(String the error message that will be thrown when comparison error occurred message, Class<?> the type the error message should be used for clazz) Registers the giving message which would be shown when differences for the giving type while comparison occurred.
private void	registerFieldLocationOfFieldsOfTypesToCompare(DualValue dualValue)
public void	registerFieldLocationToCompareBecauseOfTypesToCompare(FieldLocation fieldLocation)
public void	setIgnoreAllActualEmptyOptionalFields(boolean whether to ignore actual empty optional fields in the recursive comparison ignoringAllActualEmptyOptionalFields) Sets whether actual empty optional fields are ignored in the recursive comparison.
public void	setIgnoreAllActualNullFields(boolean whether to ignore actual null fields in the recursive comparison ignoreAllActualNullFields) Sets whether actual null fields are ignored in the recursive comparison.
public void	setIgnoreAllExpectedNullFields(boolean whether to ignore expected null fields in the recursive comparison ignoreAllExpectedNullFields) Sets whether expected null fields are ignored in the recursive comparison.
public void	setIntrospectionStrategy(RecursiveComparisonIntrospectionStrategy the `RecursiveComparisonIntrospectionStrategy` to use introspectionStrategy) Defines how objects are introspected in the recursive comparison.
private boolean	shouldBeCompared(DualValue dualValue)
pack-priv boolean	shouldIgnore(DualValue dualValue)
pack-priv boolean	shouldIgnoreCollectionOrder(FieldLocation fieldLocation)
private boolean	shouldIgnoreFieldBasedOnFieldLocation(FieldLocation fieldLocation)
private boolean	shouldIgnoreFieldBasedOnFieldValue(DualValue dualValue)
pack-priv boolean	shouldIgnoreOverriddenEqualsOf(DualValue dualValue)
pack-priv boolean	shouldIgnoreOverriddenEqualsOf(Class<?> clazz)
pack-priv boolean	shouldNotEvaluate(DualValue dualValue)
pack-priv boolean	someComparedFieldsHaveBeenSpecified()
public void	strictTypeChecking(boolean whether the recursive comparison will check that actual's type is compatible with expected's type. 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 Comparator<T>	toComparator(BiPredicate<T, U> equals)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	useOverriddenEquals() Force a recursive comparison on all fields (except java types).

Inherited from org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration:: asWrapperIfPrimitiveType describeIgnoredFields describeIgnoredFieldsRegexes describeIgnoredTypes describeRegexes getIgnoredFields getIgnoredFieldsRegexes getIgnoredTypes getIgnoredTypesRegexes ignoreFields ignoreFieldsMatchingRegexes ignoreFieldsOfTypes ignoreFieldsOfTypesMatchingRegexes join matchesAnIgnoredField matchesAnIgnoredFieldRegex

public Class RecursiveComparisonConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary