Class StandardSubjectBuilder

java.lang.Object

com.google.common.truth.StandardSubjectBuilder

Direct Known Subclasses:

Expect

public class StandardSubjectBuilder
extends Object

In a fluent assertion chain, an object with which you can do any of the following:

• Set an optional message with withMessage(java.lang.String).
• Specify the type of Subject to create with about(Subject.Factory).
• For the types of Subject built into Truth, directly specify the value under test with that(Object).

For more information about the methods in this class, see this FAQ entry.

For people extending Truth

You won't extend this type. When you write a custom subject, see our doc on extensions.

Method Summary

Modifier and Type	Method	Description
final <CustomSubjectBuilderT extends CustomSubjectBuilder> CustomSubjectBuilderT	about(CustomSubjectBuilder.Factory<CustomSubjectBuilderT> factory)	A generic, advanced method of extension of Truth to new types, which is documented on CustomSubjectBuilder.
final <S extends Subject, A> SimpleSubjectBuilder<S,A>	about(Subject.Factory<S,A> factory)	Given a factory for some Subject class, returns a builder whose that(actual) method creates instances of that class.
final void	fail()	Reports a failure.
static StandardSubjectBuilder	forCustomFailureStrategy(FailureStrategy strategy)	Returns a new instance that invokes the given FailureStrategy when a check fails.
final PrimitiveBooleanArraySubject	that(boolean @Nullable [] actual)
final PrimitiveByteArraySubject	that(byte @Nullable [] actual)
final PrimitiveCharArraySubject	that(char @Nullable [] actual)
final PrimitiveDoubleArraySubject	that(double @Nullable [] actual)
final PrimitiveFloatArraySubject	that(float @Nullable [] actual)
final PrimitiveIntArraySubject	that(int @Nullable [] actual)
final PrimitiveLongArraySubject	that(long @Nullable [] actual)
final PrimitiveShortArraySubject	that(short @Nullable [] actual)
final <ComparableT extends Comparable<?>> ComparableSubject<ComparableT>	that(@Nullable ComparableT actual)
final GuavaOptionalSubject	that(@Nullable Optional<?> actual)
final MultimapSubject	that(@Nullable Multimap<?,?> actual)
final MultisetSubject	that(@Nullable Multiset<?> actual)
final TableSubject	that(@Nullable Table<?,?,?> actual)
final BooleanSubject	that(@Nullable Boolean actual)
final ClassSubject	that(@Nullable Class<?> actual)
final DoubleSubject	that(@Nullable Double actual)
final FloatSubject	that(@Nullable Float actual)
final IntegerSubject	that(@Nullable Integer actual)
final IterableSubject	that(@Nullable Iterable<?> actual)
final LongSubject	that(@Nullable Long actual)
final Subject	that(@Nullable Object actual)
final StringSubject	that(@Nullable String actual)
final ThrowableSubject	that(@Nullable Throwable actual)
final BigDecimalSubject	that(@Nullable BigDecimal actual)
final PathSubject	that(@Nullable Path actual)
final MapSubject	that(@Nullable Map<?,?> actual)
final OptionalSubject	that(@Nullable Optional<?> actual)
final OptionalDoubleSubject	that(@Nullable OptionalDouble actual)
final OptionalIntSubject	that(@Nullable OptionalInt actual)
final OptionalLongSubject	that(@Nullable OptionalLong actual)
final IntStreamSubject	that(@Nullable IntStream actual)
final LongStreamSubject	that(@Nullable LongStream actual)
final StreamSubject	that(@Nullable Stream<?> actual)
final <T extends @Nullable Object> ObjectArraySubject<T>	that(T @Nullable [] actual)
final StandardSubjectBuilder	withMessage(@Nullable String message)	Returns a new instance that will output the given message before the main failure message.
final StandardSubjectBuilder	withMessage(String format, @Nullable Object... args)	Returns a new instance that will output the given message before the main failure message.

Methods inherited from class java.lang.Object

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

Method Details

forCustomFailureStrategy

public static StandardSubjectBuilder forCustomFailureStrategy(FailureStrategy strategy)

Returns a new instance that invokes the given FailureStrategy when a check fails. Most users should not need this. If you think you do, see the documentation on FailureStrategy.

that

public final <ComparableT extends Comparable<?>>
ComparableSubject<ComparableT> that(@Nullable ComparableT actual)

that

public final BigDecimalSubject that(@Nullable BigDecimal actual)

that

public final Subject that(@Nullable Object actual)

that

@GwtIncompatible("ClassSubject.java")
public final ClassSubject that(@Nullable Class<?> actual)

that

public final ThrowableSubject that(@Nullable Throwable actual)

that

public final LongSubject that(@Nullable Long actual)

that

public final DoubleSubject that(@Nullable Double actual)

that

public final FloatSubject that(@Nullable Float actual)

that

public final IntegerSubject that(@Nullable Integer actual)

that

public final BooleanSubject that(@Nullable Boolean actual)

that

public final StringSubject that(@Nullable String actual)

that

public final IterableSubject that(@Nullable Iterable<?> actual)

that

public final <T extends @Nullable Object>
ObjectArraySubject<T> that(T @Nullable [] actual)

that

public final PrimitiveBooleanArraySubject that(boolean @Nullable [] actual)

that

public final PrimitiveShortArraySubject that(short @Nullable [] actual)

that

public final PrimitiveIntArraySubject that(int @Nullable [] actual)

that

public final PrimitiveLongArraySubject that(long @Nullable [] actual)

that

public final PrimitiveCharArraySubject that(char @Nullable [] actual)

that

public final PrimitiveByteArraySubject that(byte @Nullable [] actual)

that

public final PrimitiveFloatArraySubject that(float @Nullable [] actual)

that

public final PrimitiveDoubleArraySubject that(double @Nullable [] actual)

that

public final GuavaOptionalSubject that(@Nullable Optional<?> actual)

that

public final MapSubject that(@Nullable Map<?,?> actual)

that

public final MultimapSubject that(@Nullable Multimap<?,?> actual)

that

public final MultisetSubject that(@Nullable Multiset<?> actual)

that

public final TableSubject that(@Nullable Table<?,?,?> actual)

that

public final OptionalSubject that(@Nullable Optional<?> actual)

Since:

1.3.0 (with access to OptionalSubject previously part of truth-java8-extension)

that

public final OptionalIntSubject that(@Nullable OptionalInt actual)

Since:

1.4.0 (with access to OptionalIntSubject previously part of truth-java8-extension)

that

public final OptionalLongSubject that(@Nullable OptionalLong actual)

Since:

1.4.0 (with access to OptionalLongSubject previously part of truth-java8-extension)

that

public final OptionalDoubleSubject that(@Nullable OptionalDouble actual)

Since:

1.4.0 (with access to OptionalDoubleSubject previously part of truth-java8-extension)

that

public final StreamSubject that(@Nullable Stream<?> actual)

Since:

1.3.0 (with access to StreamSubject previously part of truth-java8-extension)

that

public final IntStreamSubject that(@Nullable IntStream actual)

Since:

1.4.0 (with access to IntStreamSubject previously part of truth-java8-extension)

that

public final LongStreamSubject that(@Nullable LongStream actual)

Since:

1.4.0 (with access to LongStreamSubject previously part of truth-java8-extension)

that

@GwtIncompatible
@J2ObjCIncompatible
public final PathSubject that(@Nullable Path actual)

Since:

1.4.0 (with access to PathSubject previously part of truth-java8-extension)

withMessage

public final StandardSubjectBuilder withMessage(@Nullable String message)

Returns a new instance that will output the given message before the main failure message. If this method is called multiple times, the messages will appear in the order that they were specified.

withMessage

public final StandardSubjectBuilder withMessage(String format,
 @Nullable Object... args)

Returns a new instance that will output the given message before the main failure message. If this method is called multiple times, the messages will appear in the order that they were specified.

Note: the arguments will be substituted into the format template using Strings.lenientFormat. Note this only supports the %s specifier.

Throws:

IllegalArgumentException - if the number of placeholders in the format string does not equal the number of given arguments

about

public final <S extends Subject, A>
SimpleSubjectBuilder<S,A> about(Subject.Factory<S,A> factory)

Given a factory for some Subject class, returns a builder whose that(actual) method creates instances of that class. Created subjects use the previously set failure strategy and any previously set failure message.

about

public final <CustomSubjectBuilderT extends CustomSubjectBuilder>
CustomSubjectBuilderT about(CustomSubjectBuilder.Factory<CustomSubjectBuilderT> factory)

A generic, advanced method of extension of Truth to new types, which is documented on CustomSubjectBuilder. Extension creators should prefer Subject.Factory if possible.

fail

public final void fail()

Reports a failure.

To set a message, first call withMessage(java.lang.String) (or, more commonly, use the shortcut Truth.assertWithMessage(java.lang.String)).