Package org.assertj.guava.api

Class OptionalAssert<T>

java.lang.Object

org.assertj.core.api.AbstractAssert<OptionalAssert<T>,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>,Optional<T>>, Descriptable<OptionalAssert<T>>, ExtensionPoints<OptionalAssert<T>,Optional<T>>

public class OptionalAssert<T>
extends AbstractAssert<OptionalAssert<T>,Optional<T>>

Assertions for guava Optional.

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

Author:

Kornel Kiełczewski

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself, objects, throwUnsupportedExceptionOnEquals

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OptionalAssert(Optional<T> actual)

Method Summary

Modifier and Type	Method	Description
OptionalAssert<T>	contains(Object value)	Verifies that the actual Optional contains the given value.
AbstractCharSequenceAssert<?,? extends CharSequence>	extractingCharSequence()	Chain assertion on the content of the Optional.
AbstractObjectAssert<?,T>	extractingValue()	Chain assertion on the content of the Optional.
protected Optional<T>	getActual()
OptionalAssert<T>	isAbsent()	Verifies that the actual Optional contained instance is absent/null (ie.
OptionalAssert<T>	isPresent()	Verifies that the actual Optional contains a (non-null) instance.

Methods inherited from class org.assertj.core.api.AbstractAssert

areEqual, asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, doesNotHaveToString, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, hasToString, inBinary, inHexadecimal, is, isElementOfCustomAssert, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, usingRecursiveAssertion, usingRecursiveAssertion, usingRecursiveComparison, usingRecursiveComparison, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.assertj.core.api.Descriptable

as, as, as, describedAs, describedAs

Constructor Details

OptionalAssert

protected OptionalAssert(Optional<T> actual)

Method Details

getActual

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