Class OptionalSubject

java.lang.Object

com.google.common.truth.Subject

com.google.common.truth.OptionalSubject

public final class OptionalSubject
extends Subject

A subject for Optional values.

Since:

1.3.0 (previously part of truth-java8-extension)

Nested Class Summary

Nested classes/interfaces inherited from class Subject

Subject.Factory<SubjectT,ActualT>

Modifier and Type	Class	Description
static interface	Subject.Factory<SubjectT extends Subject, ActualT>	In a fluent assertion chain, the argument to the common overload of about, the method that specifies what kind of Subject to create.

Method Summary

Modifier and Type	Method	Description
void	hasValue(@Nullable Object expected)	Checks that the actual Optional contains the given value.
void	isEmpty()	Checks that the actual Optional does not contain a value.
void	isPresent()	Checks that the actual Optional contains a value.
static Subject.Factory<OptionalSubject, Optional<?>>	optionals()	Deprecated. Instead of about(optionals()).that(...), use just that(...).

Methods inherited from class Subject

actualCustomStringRepresentation, check, equals, failWithActual, failWithActual, failWithoutActual, hashCode, ignoreCheck, isAnyOf, isEqualTo, isIn, isInstanceOf, isNoneOf, isNotEqualTo, isNotIn, isNotInstanceOf, isNotNull, isNotSameInstanceAs, isNull, isSameInstanceAs, toString

Modifier and Type	Method	Description
protected String	actualCustomStringRepresentation()	Returns a string representation of the actual value for inclusion in failure messages.
protected final StandardSubjectBuilder	check(String format, @Nullable Object... args)	Returns a builder for creating a derived subject.
final boolean	equals(@Nullable Object other)	Deprecated. Object.equals(Object) is not supported on Truth subjects.
protected final void	failWithActual(Fact first, Fact... rest)	Fails, reporting a message with the given facts, followed by an automatically added fact of the form: but was: actual value.
protected final void	failWithActual(String key, @Nullable Object value)	Fails, reporting a message with two "facts": key: value but was: actual value.
protected final void	failWithoutActual(Fact first, Fact... rest)	Fails, reporting a message with the given facts, without automatically adding the actual value.
final int	hashCode()	Deprecated. Object.hashCode() is not supported on Truth subjects.
protected final StandardSubjectBuilder	ignoreCheck()	Begins a new call chain that ignores any failures.
void	isAnyOf(@Nullable Object first, @Nullable Object second, @Nullable Object... rest)	Checks that the value under test is equal to any of the given elements.
void	isEqualTo(@Nullable Object expected)	Checks that the value under test is equal to the given object.
void	isIn(@Nullable Iterable<?> iterable)	Checks that the value under test is equal to any element in the given iterable.
void	isInstanceOf(@Nullable Class<?> clazz)	Checks that the value under test is an instance of the given class.
void	isNoneOf(@Nullable Object first, @Nullable Object second, @Nullable Object... rest)	Checks that the value under test is not equal to any of the given elements.
void	isNotEqualTo(@Nullable Object other)	Checks that the value under test is not equal to the given object.
void	isNotIn(@Nullable Iterable<?> iterable)	Checks that the value under test is not equal to any element in the given iterable.
void	isNotInstanceOf(@Nullable Class<?> clazz)	Checks that the value under test is not an instance of the given class.
void	isNotNull()	Checks that the value under test is not null.
final void	isNotSameInstanceAs(@Nullable Object other)	Checks that the value under test is not the same instance as the given object.
void	isNull()	Checks that the value under test is null.
final void	isSameInstanceAs(@Nullable Object expected)	Checks that the value under test is the same instance as the given object.
String	toString()	Deprecated. Object.toString() is not supported on Truth subjects.

Methods inherited from class Object

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

Method Details

isPresent

public void isPresent()

Checks that the actual Optional contains a value.

isEmpty

public void isEmpty()

Checks that the actual Optional does not contain a value.

hasValue

public void hasValue(@Nullable Object expected)

Checks that the actual Optional contains the given value.

To make more complex assertions on the optional's value, split your assertion in two:

assertThat(myOptional).isPresent();
assertThat(myOptional.get()).contains("foo");

optionals

@Deprecated
public static Subject.Factory<OptionalSubject, Optional<?>> optionals()

Deprecated.

Instead of about(optionals()).that(...), use just that(...). Similarly, instead of assertAbout(optionals()).that(...), use just assertThat(...).

Obsolete factory instance. This factory was previously necessary for assertions like assertWithMessage(...).about(paths()).that(path)..... Now, you can perform assertions like that without the about(...) call.