Class RecursiveAssertionConfiguration
- Since:
- 3.24.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Builder forRecursiveAssertionConfiguration
static enum
Possible policies to use regarding collections (including arrays) when recursively asserting over the fields of an object tree.static enum
Possible policies to use regarding maps when recursively asserting over the fields of an object tree.static enum
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
FieldsModifier and TypeFieldDescriptionprivate boolean
private boolean
private final boolean
Fields inherited from class org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration
DEFAULT_DELIMITER
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
private void
describeCollectionAssertionPolicy
(StringBuilder description) private void
describeIgnoreAllNullFields
(StringBuilder description) private void
describeIgnoredFieldsOfTypes
(StringBuilder description) private void
describeIgnorePrimitiveFields
(StringBuilder description) private void
describeIntrospectionStrategy
(StringBuilder description) private void
describeMapAssertionPolicy
(StringBuilder description) private void
describeOptionalAssertionPolicy
(StringBuilder description) private void
describeSkipJCLTypeObjects
(StringBuilder description) boolean
(package private) RecursiveAssertionConfiguration.CollectionAssertionPolicy
(package private) RecursiveAssertionIntrospectionStrategy
(package private) RecursiveAssertionConfiguration.MapAssertionPolicy
(package private) RecursiveAssertionConfiguration.OptionalAssertionPolicy
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 thePredicate
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 specifiedRecursiveAssertionConfiguration.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 specifiedRecursiveAssertionConfiguration.MapAssertionPolicy
.void
setOptionalAssertionPolicy
(RecursiveAssertionConfiguration.OptionalAssertionPolicy optionalAssertionPolicy) Makes the recursive assertion to use the specifiedRecursiveAssertionConfiguration.OptionalAssertionPolicy
.(package private) boolean
(package private) boolean
(package private) boolean
(package private) boolean
(package private) boolean
(package private) boolean
toString()
Methods inherited from class org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration
asWrapperIfPrimitiveType, describeIgnoredFields, describeIgnoredFieldsRegexes, describeIgnoredTypes, describeRegexes, getIgnoredFields, getIgnoredFieldsRegexes, getIgnoredTypes, join, matchesAnIgnoredField, matchesAnIgnoredFieldRegex
-
Field Details
-
ignorePrimitiveFields
private boolean ignorePrimitiveFields -
skipJavaLibraryTypeObjects
private final boolean skipJavaLibraryTypeObjects -
collectionAssertionPolicy
-
mapAssertionPolicy
-
optionalAssertionPolicy
-
ignoreAllNullFields
private boolean ignoreAllNullFields -
introspectionStrategy
-
-
Constructor Details
-
RecursiveAssertionConfiguration
-
-
Method Details
-
ignorePrimitiveFields
public void ignorePrimitiveFields(boolean ignorePrimitiveFields) Choose between running thePredicate
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 toobjectField
. If ignoring primitives it set to true, the assertion will only be applied toobjectField
.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
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 classAbstractRecursiveOperationConfiguration
- Parameters:
fieldsToIgnore
- the fields to ignore in the object under test.
-
ignoreFieldsMatchingRegexes
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 classAbstractRecursiveOperationConfiguration
- Parameters:
regexes
- regexes used to ignore fields in the assertion.
-
ignoreFieldsOfTypes
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 classAbstractRecursiveOperationConfiguration
- 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 specifiedRecursiveAssertionConfiguration.OptionalAssertionPolicy
.- Parameters:
optionalAssertionPolicy
- theRecursiveAssertionConfiguration.OptionalAssertionPolicy
to use.
-
setMapAssertionPolicy
public void setMapAssertionPolicy(RecursiveAssertionConfiguration.MapAssertionPolicy mapAssertionPolicy) Makes the recursive assertion to use the specifiedRecursiveAssertionConfiguration.MapAssertionPolicy
.- Parameters:
mapAssertionPolicy
- theRecursiveAssertionConfiguration.MapAssertionPolicy
to use.
-
setCollectionAssertionPolicy
public void setCollectionAssertionPolicy(RecursiveAssertionConfiguration.CollectionAssertionPolicy collectionAssertionPolicy) Makes the recursive assertion to use the specifiedRecursiveAssertionConfiguration.CollectionAssertionPolicy
.- Parameters:
collectionAssertionPolicy
- theRecursiveAssertionConfiguration.CollectionAssertionPolicy
to use.
-
setIntrospectionStrategy
Defines how objects are introspected in the recursive assertion.Default to
DefaultRecursiveAssertionIntrospectionStrategy
that introspects all fields (including inherited ones).- Parameters:
introspectionStrategy
- theRecursiveAssertionIntrospectionStrategy
to use
-
toString
-
shouldIgnorePrimitiveFields
boolean shouldIgnorePrimitiveFields() -
shouldSkipJavaLibraryTypeObjects
boolean shouldSkipJavaLibraryTypeObjects() -
getCollectionAssertionPolicy
RecursiveAssertionConfiguration.CollectionAssertionPolicy getCollectionAssertionPolicy() -
getMapAssertionPolicy
RecursiveAssertionConfiguration.MapAssertionPolicy getMapAssertionPolicy() -
getOptionalAssertionPolicy
RecursiveAssertionConfiguration.OptionalAssertionPolicy getOptionalAssertionPolicy() -
getIntrospectionStrategy
RecursiveAssertionIntrospectionStrategy getIntrospectionStrategy() -
shouldIgnoreMap
boolean shouldIgnoreMap() -
shouldIgnoreOptional
boolean shouldIgnoreOptional() -
shouldIgnoreContainer
boolean shouldIgnoreContainer() -
shouldIgnoreAllNullFields
boolean shouldIgnoreAllNullFields() -
describeIgnoreAllNullFields
-
describeIgnorePrimitiveFields
-
describeSkipJCLTypeObjects
-
describeCollectionAssertionPolicy
-
describeMapAssertionPolicy
-
describeOptionalAssertionPolicy
-
describeIgnoredFieldsOfTypes
-
describeIntrospectionStrategy
-
equals
-
hashCode
public int hashCode() -
builder
- Returns:
- A
RecursiveAssertionConfiguration.Builder
that will assist the developer in creating a valid instance ofRecursiveAssertionConfiguration
.
-