Package org.assertj.core.api.recursive

Class AbstractRecursiveOperationConfiguration

java.lang.Object
org.assertj.core.api.recursive.AbstractRecursiveOperationConfiguration
Direct Known Subclasses:
RecursiveAssertionConfiguration, RecursiveComparisonConfiguration
public abstract class AbstractRecursiveOperationConfiguration extends Object

  • Field Details

  • Constructor Details

  • Method Details

    • ignoreFields

      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 - the fields of the object under test to ignore in the comparison.

    • getIgnoredFields

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

    • ignoreFieldsMatchingRegexes

      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 - regexes used to ignore fields in the comparison.

    • getIgnoredFieldsRegexes

      public List<Pattern> getIgnoredFieldsRegexes()

    • 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.

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

      Parameters:
      types - the types of the object under test to ignore in the comparison.

    • ignoreFieldsOfTypesMatchingRegexes

      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 - regexes specifying the types to ignore.

    • asWrapperIfPrimitiveType

      protected static Class<?> asWrapperIfPrimitiveType(Class<?> type)

    • getIgnoredTypes

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

    • getIgnoredTypesRegexes

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

    • describeIgnoredFields

      protected void describeIgnoredFields(StringBuilder description)

    • describeIgnoredFieldsRegexes

      protected void describeIgnoredFieldsRegexes(StringBuilder description)

    • describeIgnoredTypes

      protected String describeIgnoredTypes()

    • describeRegexes

      protected String describeRegexes(List<Pattern> regexes)

    • join

      protected static String join(Collection<String> typesDescription)

    • matchesAnIgnoredFieldRegex

      public boolean matchesAnIgnoredFieldRegex(FieldLocation fieldLocation)

    • matchesAnIgnoredField

      public boolean matchesAnIgnoredField(FieldLocation fieldLocation)