Class OptionalAssert<T>

java.lang.Object
org.assertj.core.api.AbstractAssert<OptionalAssert<T>,com.google.common.base.Optional<T>>
org.assertj.guava.api.OptionalAssert<T>
Type Parameters:
T - the type of elements of the tested Optional value
All Implemented Interfaces:
Assert<OptionalAssert<T>,com.google.common.base.Optional<T>>, Descriptable<OptionalAssert<T>>, ExtensionPoints<OptionalAssert<T>,com.google.common.base.Optional<T>>

public class OptionalAssert<T> extends AbstractAssert<OptionalAssert<T>,com.google.common.base.Optional<T>>
Assertions for guava Optional.

To create an instance of this class, invoke Assertions.assertThat(Optional)

  • Constructor Details

    • OptionalAssert

      protected OptionalAssert(com.google.common.base.Optional<T> actual)
  • Method Details

    • getActual

      protected com.google.common.base.Optional<T> getActual()
    • contains

      public OptionalAssert<T> contains(Object value)
      Verifies that the actual Optional contains the given value.

      Example :

       Optional<String> optional = Optional.of("Test");
      
       assertThat(optional).contains("Test");
      Parameters:
      value - the value to look for in actual Optional.
      Returns:
      this OptionalAssert for assertions chaining.
      Throws:
      AssertionError - if the actual Optional is null.
      AssertionError - if the actual Optional contains nothing or does not have the given value.
    • isAbsent

      public OptionalAssert<T> isAbsent()
      Verifies that the actual Optional contained instance is absent/null (ie. not Optional.isPresent()).

      Example :

       Optional<String> optional = Optional.absent();
      
       assertThat(optional).isAbsent();
      Returns:
      this OptionalAssert for assertions chaining.
      Throws:
      AssertionError - if the actual Optional is null.
      AssertionError - if the actual Optional contains a (non-null) instance.
    • isPresent

      public OptionalAssert<T> isPresent()
      Verifies that the actual Optional contains a (non-null) instance.

      Example :

       Optional<String> optional = Optional.of("value");
      
       assertThat(optional).isPresent();
      Returns:
      this OptionalAssert for assertions chaining.
      Throws:
      AssertionError - if the actual Optional is null.
      AssertionError - if the actual Optional contains a null instance.
    • extractingValue

      public AbstractObjectAssert<?,T> extractingValue()
      Chain assertion on the content of the Optional.

      Example :

       Optional<Number> optional = Optional.of(12L);
      
       assertThat(optional).extractingValue().isInstanceOf(Long.class);
      Returns:
      a new AbstractObjectAssert for assertions chaining on the content of the Optional.
      Throws:
      AssertionError - if the actual Optional is null.
      AssertionError - if the actual Optional contains a null instance.
    • extractingCharSequence

      public AbstractCharSequenceAssert<?,? extends CharSequence> extractingCharSequence()
      Chain assertion on the content of the Optional.

      Example :

       Optional<String> optional = Optional.of("Bill");
      
       assertThat(optional).extractingCharSequence().startsWith("Bi");
      Returns:
      a new AbstractCharSequenceAssert for assertions chaining on the content of the Optional.
      Throws:
      AssertionError - if the actual Optional is null.
      AssertionError - if the actual Optional contains a null instance.