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

Enum RecursiveAssertionConfiguration.OptionalAssertionPolicy

java.lang.Object
java.lang.Enum<RecursiveAssertionConfiguration.OptionalAssertionPolicy>
org.assertj.core.api.recursive.assertion.RecursiveAssertionConfiguration.OptionalAssertionPolicy
All Implemented Interfaces:
Serializable, Comparable<RecursiveAssertionConfiguration.OptionalAssertionPolicy>
Enclosing class:
RecursiveAssertionConfiguration
public static enum RecursiveAssertionConfiguration.OptionalAssertionPolicy extends Enum<RecursiveAssertionConfiguration.OptionalAssertionPolicy>
Possible policies to use regarding optionals when recursively asserting over the fields of an object tree.

  • Enum Constant Details

    • OPTIONAL_VALUE_ONLY

      public static final RecursiveAssertionConfiguration.OptionalAssertionPolicy OPTIONAL_VALUE_ONLY
      Apply the Predicate (recursively) to the value of the optional field but not the optional field.

      Consider the following example: 

       class Parent {
   Optional<String> greeting = Optional.of("Hi");
 }

 Parent parent = new Parent();

 assertThat(parent).usingRecursiveAssertion()
                   .allFieldsSatisfy(field -> myPredicate(field));
      With this policy, myPredicate(field) is applied to the optional value "Hi" but not to the greeting Optional field.

    • OPTIONAL_OBJECT_ONLY

      public static final RecursiveAssertionConfiguration.OptionalAssertionPolicy OPTIONAL_OBJECT_ONLY
      Apply the Predicate to the optional field but not to its value.

      Consider the following example: 

       class Parent {
   Optional<String> greeting = Optional.of("Hi");
 }

 Parent parent = new Parent();

 assertThat(parent).usingRecursiveAssertion()
                   .allFieldsSatisfy(field -> myPredicate(field));
      With this policy, myPredicate(field) is applied to the greeting Optional field but not to the optional value "Hi".

    • OPTIONAL_OBJECT_AND_VALUE

      public static final RecursiveAssertionConfiguration.OptionalAssertionPolicy OPTIONAL_OBJECT_AND_VALUE
      Apply the Predicate to the optional field as well as to (recursively) its value.

      Consider the following example: 

       class Parent {
   List<String> greetings = new Optional<>();
 }

 Parent parent = new Parent();
 parent.greetings.add("Hello");
 parent.greetings.add("Salut");

 assertThat(parent).usingRecursiveAssertion()
                   .allFieldsSatisfy(field -> myPredicate(field));
      With this policy, myPredicate(field) is applied to the greeting Optional field and its value "Hi".

  • Method Details

    • values

      public static RecursiveAssertionConfiguration.OptionalAssertionPolicy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static RecursiveAssertionConfiguration.OptionalAssertionPolicy valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null