Modifier and Type	Class and Description
protected static class	AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE extends AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE>>

Modifier and Type	Field and Description
protected static final String	DEFAULT_DELIMITER
private final Set<String>	ignoredFields
private final List<Pattern>	ignoredFieldsRegexes
private final Set<Class<?>>	ignoredTypes
private final List<Pattern>	ignoredTypesRegexes

Access	Constructor and Description
protected	AbstractRecursiveOperationConfiguration(AbstractRecursiveOperationConfiguration.AbstractBuilder<?> builder)
protected	AbstractRecursiveOperationConfiguration()

Method Summary

Modifier and Type	Method and Description
protected static Class<?>	asWrapperIfPrimitiveType(Class<?> type)
protected void	describeIgnoredFields(StringBuilder description)
private String	describeIgnoredFields()
protected void	describeIgnoredFieldsRegexes(StringBuilder description)
protected String	describeIgnoredTypes()
protected String	describeRegexes(List<Pattern> regexes)
public Set<String>	Returns: the set of fields from the object under test to ignore in the recursive comparison. getIgnoredFields() Returns the set of fields from the object under test to ignore in the recursive comparison.
public List<Pattern>	getIgnoredFieldsRegexes()
public Set<Class<?>>	Returns: the set of fields from the object under test types to ignore in the recursive comparison. getIgnoredTypes() Returns the set of fields from the object under test types to ignore in the recursive comparison.
public List<Pattern>	Returns: the regexes that will be used to ignore fields with types matching these regexes in the recursive comparison. getIgnoredTypesRegexes() Returns the regexes that will be used to ignore fields with types matching these regexes in the recursive comparison.
public void	ignoreFields(String... the fields of the object under test to ignore in the comparison. fieldsToIgnore) Adds the given fields to the set of fields from the object under test to ignore in the recursive comparison.
public void	ignoreFieldsMatchingRegexes(String... regexes used to ignore fields in the comparison. regexes) Allows to ignore in the recursive comparison the object under test fields matching the given regexes.
public void	ignoreFieldsOfTypes(Class<?>... the types of the object under test to ignore in the comparison. types) Makes the recursive assertion to ignore the object under test fields of the given types.
public void	ignoreFieldsOfTypesMatchingRegexes(String... regexes specifying the types to ignore. regexes) Makes the recursive comparison to ignore the fields of the object under test having types matching one of the given regexes.
protected static String	join(Collection<String> typesDescription)
public boolean	matchesAnIgnoredField(FieldLocation fieldLocation)
public boolean	matchesAnIgnoredFieldRegex(FieldLocation fieldLocation)
private static List<Pattern>	toPatterns(String[] regexes)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_DELIMITER	back to summary
protected static final String DEFAULT_DELIMITER

ignoredFields	back to summary
private final Set<String> ignoredFields

ignoredFieldsRegexes	back to summary
private final List<Pattern> ignoredFieldsRegexes

ignoredTypes	back to summary
private final Set<Class<?>> ignoredTypes

ignoredTypesRegexes	back to summary
private final List<Pattern> ignoredTypesRegexes

Constructor Detail

AbstractRecursiveOperationConfiguration	back to summary
protected AbstractRecursiveOperationConfiguration(AbstractRecursiveOperationConfiguration.AbstractBuilder<?> builder)

AbstractRecursiveOperationConfiguration	back to summary
protected AbstractRecursiveOperationConfiguration()

Method Detail

asWrapperIfPrimitiveType	back to summary
protected static Class<?> asWrapperIfPrimitiveType(Class<?> type)

describeIgnoredFields	back to summary
protected void describeIgnoredFields(StringBuilder description)

describeIgnoredFields	back to summary
private String describeIgnoredFields()

describeIgnoredFieldsRegexes	back to summary
protected void describeIgnoredFieldsRegexes(StringBuilder description)

describeIgnoredTypes	back to summary
protected String describeIgnoredTypes()

describeRegexes	back to summary
protected String describeRegexes(List<Pattern> regexes)

getIgnoredFields	back to summary
public Set<String> getIgnoredFields() Returns the set of fields from the object under test to ignore in the recursive comparison. Returns:Set<String> the set of fields from the object under test to ignore in the recursive comparison.

getIgnoredFields

back to summary

public Set<String> getIgnoredFields()

Returns the set of fields from the object under test to ignore in the recursive comparison.

Returns:Set<String>: the set of fields from the object under test to ignore in the recursive comparison.

getIgnoredFieldsRegexes	back to summary
public List<Pattern> getIgnoredFieldsRegexes()

getIgnoredTypes	back to summary
public Set<Class<?>> getIgnoredTypes() Returns the set of fields from the object under test types to ignore in the recursive comparison. Returns:Set<Class<?>> the set of fields from the object under test types to ignore in the recursive comparison.

getIgnoredTypes

back to summary

public Set<Class<?>> getIgnoredTypes()

Returns the set of fields from the object under test types to ignore in the recursive comparison.

Returns:Set<Class<?>>: the set of fields from the object under test types to ignore in the recursive comparison.

getIgnoredTypesRegexes	back to summary
public List<Pattern> getIgnoredTypesRegexes() Returns the regexes that will be used to ignore fields with types matching these regexes in the recursive comparison. Returns:List<Pattern> the regexes that will be used to ignore fields with types matching these regexes in the recursive comparison.

getIgnoredTypesRegexes

back to summary

public List<Pattern> getIgnoredTypesRegexes()

Returns the regexes that will be used to ignore fields with types matching these regexes in the recursive comparison.

Returns:List<Pattern>: the regexes that will be used to ignore fields with types matching these regexes in the recursive comparison.

ignoreFields back to summary

ignoreFields	back to summary
public void ignoreFields(String... fieldsToIgnore) Adds the given fields to the set of fields from the object under test to ignore in the recursive comparison. The fields are ignored by name, not by value. See `RecursiveComparisonAssert#ignoringFields(String...)` for examples. Parameters fieldsToIgnore:String[] the fields of the object under test to ignore in the comparison.

public void ignoreFields(String... fieldsToIgnore)

Adds the given fields to the set of fields from the object under test to ignore in the recursive comparison.

The fields are ignored by name, not by value.

See RecursiveComparisonAssert#ignoringFields(String...) for examples.

Parameters

fieldsToIgnore:String[]: the fields of the object under test to ignore in the comparison.

ignoreFieldsMatchingRegexes back to summary

ignoreFieldsMatchingRegexes	back to summary
public void ignoreFieldsMatchingRegexes(String... regexes) Allows to ignore in the recursive comparison the object under test fields matching the given regexes. The given regexes are added to the already registered ones. See `RecursiveComparisonAssert#ignoringFieldsMatchingRegexes(String...)` for examples. Parameters regexes:String[] regexes used to ignore fields in the comparison.

public void ignoreFieldsMatchingRegexes(String... regexes)

Allows to ignore in the recursive comparison the object under test fields matching the given regexes. The given regexes are added to the already registered ones.

See RecursiveComparisonAssert#ignoringFieldsMatchingRegexes(String...) for examples.

Parameters

regexes:String[]: regexes used to ignore fields in the comparison.

ignoreFieldsOfTypes back to summary

ignoreFieldsOfTypes	back to summary
public void ignoreFieldsOfTypes(Class<?>... types) Makes the recursive assertion to ignore the object under test fields of the given types. The fields are ignored if their types exactly match one of the ignored types, for example if a field is a subtype of an ignored type it is not ignored. If some object under test fields are null it is not possible to evaluate their types and thus these fields are not ignored. Example: see `RecursiveComparisonAssert#ignoringFieldsOfTypes(Class[])`. Parameters types:Class<?>[] the types of the object under test to ignore in the comparison.

public void ignoreFieldsOfTypes(Class<?>... types)

Makes the recursive assertion to ignore the object under test fields of the given types. The fields are ignored if their types exactly match one of the ignored types, for example if a field is a subtype of an ignored type it is not ignored.

If some object under test fields are null it is not possible to evaluate their types and thus these fields are not ignored.

Example: see RecursiveComparisonAssert#ignoringFieldsOfTypes(Class[]).

Parameters

types:Class<?>[]: the types of the object under test to ignore in the comparison.

ignoreFieldsOfTypesMatchingRegexes back to summary

ignoreFieldsOfTypesMatchingRegexes	back to summary
public void ignoreFieldsOfTypesMatchingRegexes(String... regexes) Makes the recursive comparison to ignore the fields of the object under test having types matching one of the given regexes. The fields are ignored if their types exactly match one of the regexes, if a field is a subtype of a matched type it is not ignored. One use case of this method is to ignore types that can't be introspected. If `strictTypeChecking` mode is enabled and a field of the object under test is null, the recursive comparison evaluates the corresponding expected field's type (if not null), if it is disabled then the field is evaluated as usual (i.e. it is not ignored). Warning primitive types are not directly supported because under the hood they are converted to their corresponding wrapping types, for example `int` to `java.lang.Integer`. The preferred way to ignore primitive types is to use `ignoreFieldsOfTypes(Class[])`. Another way is to ignore the wrapping type, for example ignoring `java.lang.Integer` ignores both `java.lang.Integer` and `int` fields. Example: see `RecursiveComparisonAssert#ignoringFieldsOfTypesMatchingRegexes(String...)`. Parameters regexes:String[] regexes specifying the types to ignore.

public void ignoreFieldsOfTypesMatchingRegexes(String... regexes)

Makes the recursive comparison to ignore the fields of the object under test having types matching one of the given regexes. The fields are ignored if their types exactly match one of the regexes, if a field is a subtype of a matched type it is not ignored.

One use case of this method is to ignore types that can't be introspected.

If strictTypeChecking mode is enabled and a field of the object under test is null, the recursive comparison evaluates the corresponding expected field's type (if not null), if it is disabled then the field is evaluated as usual (i.e. it is not ignored).

Warning

primitive types are not directly supported because under the hood they are converted to their corresponding wrapping types, for example int to java.lang.Integer. The preferred way to ignore primitive types is to use ignoreFieldsOfTypes(Class[]). Another way is to ignore the wrapping type, for example ignoring java.lang.Integer ignores both java.lang.Integer and int fields.

Example: see RecursiveComparisonAssert#ignoringFieldsOfTypesMatchingRegexes(String...).

Parameters

regexes:String[]: regexes specifying the types to ignore.

join	back to summary
protected static String join(Collection<String> typesDescription)

matchesAnIgnoredField	back to summary
public boolean matchesAnIgnoredField(FieldLocation fieldLocation)

matchesAnIgnoredFieldRegex	back to summary
public boolean matchesAnIgnoredFieldRegex(FieldLocation fieldLocation)

toPatterns	back to summary
private static List<Pattern> toPatterns(String[] regexes)

org.assertj.core.api.recursive back to summary

protected Class AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE extends AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE>>

Class Inheritance

extends Object

java.lang.Object
org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration.AbstractBuilder

Known Direct Subclasses

org.assertj.core.api.recursive.assertion.RecursiveAssertionConfiguration.Builder, org.assertj.core.api.recursive.comparison.RecursiveComparisonConfiguration.Builder

Field Summary

Modifier and Type	Field and Description
private String[]	ignoredFields
private String[]	ignoredFieldsMatchingRegexes
private Class<?>[]	ignoredTypes
private final BUILDER_TYPE	thisBuilder

Constructor Summary

Access	Constructor and Description
protected	AbstractBuilder(Class<? extends AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE>> selfType)

Method Summary

Modifier and Type	Method and Description
public BUILDER_TYPE	Returns: this builder. withIgnoredFields(String... the fields of the object under test to ignore in the comparison. fieldsToIgnore) Adds the given fields to the set of fields from the object under test to ignore in the recursive comparison.
public BUILDER_TYPE	Returns: this builder. withIgnoredFieldsMatchingRegexes(String... regexes used to ignore fields in the comparison. regexes) Allows to ignore in the recursive comparison the object under test fields matching the given regexes.
public BUILDER_TYPE	Returns: this builder. withIgnoredFieldsOfTypes(Class<?>... the types of the object under test to ignore in the comparison. types) Adds the given types to the list fields from the object under test types to ignore in the recursive comparison.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ignoredFields	back to summary
private String[] ignoredFields

ignoredFieldsMatchingRegexes	back to summary
private String[] ignoredFieldsMatchingRegexes

ignoredTypes	back to summary
private Class<?>[] ignoredTypes

thisBuilder	back to summary
private final BUILDER_TYPE thisBuilder

Constructor Detail

AbstractBuilder	back to summary
protected AbstractBuilder(Class<? extends AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE>> selfType) Annotations @SuppressWarnings:unchecked

Method Detail

withIgnoredFields back to summary

withIgnoredFields	back to summary
public BUILDER_TYPE withIgnoredFields(String... fieldsToIgnore) Adds the given fields to the set of fields from the object under test to ignore in the recursive comparison. Nested fields can be specified like this: home.address.street. See `RecursiveComparisonAssert#ignoringFields(String...)` for examples. Parameters fieldsToIgnore:String[] the fields of the object under test to ignore in the comparison. Returns:BUILDER_TYPE this builder.

public BUILDER_TYPE withIgnoredFields(String... fieldsToIgnore)

Adds the given fields to the set of fields from the object under test to ignore in the recursive comparison. Nested fields can be specified like this: home.address.street.

See RecursiveComparisonAssert#ignoringFields(String...) for examples.

Parameters

fieldsToIgnore:String[]: the fields of the object under test to ignore in the comparison.

Returns:BUILDER_TYPE

this builder.

withIgnoredFieldsMatchingRegexes back to summary

withIgnoredFieldsMatchingRegexes	back to summary
public BUILDER_TYPE withIgnoredFieldsMatchingRegexes(String... regexes) Allows to ignore in the recursive comparison the object under test fields matching the given regexes. The given regexes are added to the already registered ones. See `RecursiveComparisonAssert#ignoringFieldsMatchingRegexes(String...)` for examples. Parameters regexes:String[] regexes used to ignore fields in the comparison. Returns:BUILDER_TYPE this builder.

public BUILDER_TYPE withIgnoredFieldsMatchingRegexes(String... regexes)

Allows to ignore in the recursive comparison the object under test fields matching the given regexes. The given regexes are added to the already registered ones.

See RecursiveComparisonAssert#ignoringFieldsMatchingRegexes(String...) for examples.

Parameters

regexes:String[]: regexes used to ignore fields in the comparison.

Returns:BUILDER_TYPE

this builder.

withIgnoredFieldsOfTypes back to summary

withIgnoredFieldsOfTypes	back to summary
public BUILDER_TYPE withIgnoredFieldsOfTypes(Class<?>... types) Adds the given types to the list fields from the object under test types to ignore in the recursive comparison. The fields are ignored if their types exactly match one of the ignored types, if a field is a subtype of an ignored type it won't be ignored. Note that if some object under test fields are null, they are not ignored by this method as their type can't be evaluated. See `RecursiveComparisonAssert#ignoringFieldsOfTypes(Class...)` for examples. Parameters types:Class<?>[] the types of the object under test to ignore in the comparison. Returns:BUILDER_TYPE this builder.

public BUILDER_TYPE withIgnoredFieldsOfTypes(Class<?>... types)

Adds the given types to the list fields from the object under test types to ignore in the recursive comparison. The fields are ignored if their types exactly match one of the ignored types, if a field is a subtype of an ignored type it won't be ignored.

Note that if some object under test fields are null, they are not ignored by this method as their type can't be evaluated.

See RecursiveComparisonAssert#ignoringFieldsOfTypes(Class...) for examples.

Parameters

types:Class<?>[]: the types of the object under test to ignore in the comparison.

Returns:BUILDER_TYPE

this builder.

public abstract Class AbstractRecursiveOperationConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE extends AbstractRecursiveOperationConfiguration.AbstractBuilder<BUILDER_TYPE>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail