Package org.assertj.core.api.recursive.assertion

Class RecursiveAssertionConfiguration

java.lang.Object

org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration

org.assertj.core.api.recursive.assertion.RecursiveAssertionConfiguration

public class RecursiveAssertionConfiguration
extends AbstractRecursiveOperationConfiguration

Configuration for recursive assertions.

Since:

3.24.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecursiveAssertionConfiguration.Builder	Builder for RecursiveAssertionConfiguration
static enum	RecursiveAssertionConfiguration.CollectionAssertionPolicy	Possible policies to use regarding collections (including arrays) when recursively asserting over the fields of an object tree.
static enum	RecursiveAssertionConfiguration.MapAssertionPolicy	Possible policies to use regarding maps when recursively asserting over the fields of an object tree.
static enum	RecursiveAssertionConfiguration.OptionalAssertionPolicy	Possible policies to use regarding optionals when recursively asserting over the fields of an object tree.

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

Method Summary

Modifier and Type	Method	Description
static RecursiveAssertionConfiguration.Builder	builder()
boolean	equals(Object o)
int	hashCode()
void	ignoreAllNullFields(boolean ignoreAllNullFields)	Makes the recursive assertion to ignore all null fields.
void	ignoreFields(String... fieldsToIgnore)	Makes the recursive assertion to ignore the specified fields in the object under test.
void	ignoreFieldsMatchingRegexes(String... regexes)	Makes the recursive assertion to ignore the fields matching the specified regexes in the object under test.
void	ignoreFieldsOfTypes(Class<?>... types)	Makes the recursive assertion to ignore the object under test fields of the given types.
void	ignorePrimitiveFields(boolean ignorePrimitiveFields)	Choose between running the Predicate in use over the primitive fields of an object in an object tree or not, by default asserting over primitives is enabled.
void	setCollectionAssertionPolicy(RecursiveAssertionConfiguration.CollectionAssertionPolicy collectionAssertionPolicy)	Makes the recursive assertion to use the specified RecursiveAssertionConfiguration.CollectionAssertionPolicy.
void	setIntrospectionStrategy(RecursiveAssertionIntrospectionStrategy introspectionStrategy)	Defines how objects are introspected in the recursive assertion.
void	setMapAssertionPolicy(RecursiveAssertionConfiguration.MapAssertionPolicy mapAssertionPolicy)	Makes the recursive assertion to use the specified RecursiveAssertionConfiguration.MapAssertionPolicy.
void	setOptionalAssertionPolicy(RecursiveAssertionConfiguration.OptionalAssertionPolicy optionalAssertionPolicy)	Makes the recursive assertion to use the specified RecursiveAssertionConfiguration.OptionalAssertionPolicy.
String	toString()

Methods inherited from class org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration

asWrapperIfPrimitiveType, describeIgnoredFields, describeIgnoredFieldsRegexes, describeIgnoredTypes, describeRegexes, getIgnoredFields, getIgnoredFieldsRegexes, getIgnoredTypes, getIgnoredTypesRegexes, ignoreFieldsOfTypesMatchingRegexes, join, matchesAnIgnoredField, matchesAnIgnoredFieldRegex

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

ignorePrimitiveFields

public void ignorePrimitiveFields(boolean ignorePrimitiveFields)

Choose between running the Predicate in use over the primitive fields of an object in an object tree or not, by default asserting over primitives is enabled.

For example, consider the following class:

 class Example {
    public int primitiveField;
    public String objectField;
  } 

By default, the assertion being applied recursively is applied to primitiveField and to objectField. If ignoring primitives it set to true, the assertion will only be applied to objectField.

If you elect to assert over primitives then it is your own responsibility as a developer to ensure that your Predicate can handle (boxed) primitive arguments.

ignoreAllNullFields

public void ignoreAllNullFields(boolean ignoreAllNullFields)

Makes the recursive assertion to ignore all null fields.

Example: see RecursiveAssertionAssert.ignoringAllNullFields()

Parameters:

ignoreAllNullFields - whether to ignore empty optional fields in the recursive comparison

ignoreFields

public void ignoreFields(String... fieldsToIgnore)

Makes the recursive assertion to ignore the specified fields in the object under test.

When a field is ignored, all its fields are ignored too.

Example: see RecursiveAssertionAssert.ignoringFields(String...)

Overrides:

ignoreFields in class AbstractRecursiveOperationConfiguration

Parameters:

fieldsToIgnore - the fields to ignore in the object under test.

ignoreFieldsMatchingRegexes

public void ignoreFieldsMatchingRegexes(String... regexes)

Makes the recursive assertion to ignore the fields matching the specified regexes in the object under test.

When a field is ignored, all its fields are ignored too.

Example: see RecursiveAssertionAssert.ignoringFieldsMatchingRegexes(String...)

Overrides:

ignoreFieldsMatchingRegexes in class AbstractRecursiveOperationConfiguration

Parameters:

regexes - regexes used to ignore fields in the assertion.

ignoreFieldsOfTypes

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.

When a field is ignored, all its fields are ignored too.

Example: see RecursiveAssertionAssert.ignoringFieldsOfTypes(Class[])

Overrides:

ignoreFieldsOfTypes in class AbstractRecursiveOperationConfiguration

Parameters:

types - the types we want to ignore in the object under test fields.

setOptionalAssertionPolicy

public void setOptionalAssertionPolicy(RecursiveAssertionConfiguration.OptionalAssertionPolicy optionalAssertionPolicy)

Makes the recursive assertion to use the specified RecursiveAssertionConfiguration.OptionalAssertionPolicy.

Parameters:

optionalAssertionPolicy - the RecursiveAssertionConfiguration.OptionalAssertionPolicy to use.

setMapAssertionPolicy

public void setMapAssertionPolicy(RecursiveAssertionConfiguration.MapAssertionPolicy mapAssertionPolicy)

Makes the recursive assertion to use the specified RecursiveAssertionConfiguration.MapAssertionPolicy.

Parameters:

mapAssertionPolicy - the RecursiveAssertionConfiguration.MapAssertionPolicy to use.

setCollectionAssertionPolicy

public void setCollectionAssertionPolicy(RecursiveAssertionConfiguration.CollectionAssertionPolicy collectionAssertionPolicy)

Makes the recursive assertion to use the specified RecursiveAssertionConfiguration.CollectionAssertionPolicy.

Parameters:

collectionAssertionPolicy - the RecursiveAssertionConfiguration.CollectionAssertionPolicy to use.

setIntrospectionStrategy

public void setIntrospectionStrategy(RecursiveAssertionIntrospectionStrategy introspectionStrategy)

Defines how objects are introspected in the recursive assertion.

Default to DefaultRecursiveAssertionIntrospectionStrategy that introspects all fields (including inherited ones).

Parameters:

introspectionStrategy - the RecursiveAssertionIntrospectionStrategy to use

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static RecursiveAssertionConfiguration.Builder builder()

Returns:

A RecursiveAssertionConfiguration.Builder that will assist the developer in creating a valid instance of RecursiveAssertionConfiguration.