com.google.common.truth

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 and Description
<CustomSubjectBuilderT extends CustomSubjectBuilder> CustomSubjectBuilderT	about(CustomSubjectBuilder.Factory<CustomSubjectBuilderT> factory)
<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.
void	fail() Reports a failure.
void	fail(String format, Object... args) Deprecated. Instead of assert_().fail(...), use assertWithMessage(...).fail(). Similarly, instead of expect.fail(...), use expect.withMessage(...).fail(), and so forth.
static StandardSubjectBuilder	forCustomFailureStrategy(FailureStrategy failureStrategy) Returns a new instance that invokes the given FailureStrategy when a check fails.
AtomicLongMapSubject	that(AtomicLongMap<?> actual) Deprecated. Perform assertions on the AtomicLongMap.asMap() view.
BigDecimalSubject	that(BigDecimal actual)
BooleanSubject	that(Boolean actual)
PrimitiveBooleanArraySubject	that(boolean[] actual)
PrimitiveByteArraySubject	that(byte[] actual)
PrimitiveCharArraySubject	that(char[] actual)
ClassSubject	that(Class<?> actual)
<ComparableT extends Comparable<?>> ComparableSubject<ComparableT>	that(ComparableT actual)
DoubleSubject	that(Double actual)
PrimitiveDoubleArraySubject	that(double[] actual)
FloatSubject	that(Float actual)
PrimitiveFloatArraySubject	that(float[] actual)
PrimitiveIntArraySubject	that(int[] actual)
IntegerSubject	that(Integer actual)
IterableSubject	that(Iterable<?> actual)
LongSubject	that(Long actual)
PrimitiveLongArraySubject	that(long[] actual)
MapSubject	that(Map<?,?> actual)
MultimapSubject	that(Multimap<?,?> actual)
MultisetSubject	that(Multiset<?> actual)
Subject	that(Object actual)
GuavaOptionalSubject	that(Optional<?> actual)
PrimitiveShortArraySubject	that(short[] actual)
StringSubject	that(String actual)
<T> ObjectArraySubject<T>	that(T[] actual)
TableSubject	that(Table<?,?,?> actual)
ThrowableSubject	that(Throwable actual)
StandardSubjectBuilder	withMessage(String messageToPrepend) Returns a new instance that will output the given message before the main failure message.
StandardSubjectBuilder	withMessage(String format, 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 Detail

forCustomFailureStrategy

public static StandardSubjectBuilder forCustomFailureStrategy(FailureStrategy failureStrategy)

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(@NullableDecl
                                                                                     ComparableT actual)

that

public final BigDecimalSubject that(@NullableDecl
                                    BigDecimal actual)

that

public final Subject that(@NullableDecl
                          Object actual)

that

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

that

public final ThrowableSubject that(@NullableDecl
                                   Throwable actual)

that

public final LongSubject that(@NullableDecl
                              Long actual)

that

public final DoubleSubject that(@NullableDecl
                                Double actual)

that

public final FloatSubject that(@NullableDecl
                               Float actual)

that

public final IntegerSubject that(@NullableDecl
                                 Integer actual)

that

public final BooleanSubject that(@NullableDecl
                                 Boolean actual)

that

public final StringSubject that(@NullableDecl
                                String actual)

that

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

that

public final <T> ObjectArraySubject<T> that(@NullableDecl
                                            T[] actual)

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

@Deprecated
public final AtomicLongMapSubject that(@NullableDecl
                                                   AtomicLongMap<?> actual)

Deprecated. Perform assertions on the AtomicLongMap.asMap() view.

withMessage

public final StandardSubjectBuilder withMessage(@NullableDecl
                                                String messageToPrepend)

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,
                                                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)

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

fail

@Deprecated
public final void fail(String format,
                                   Object... args)

Deprecated. Instead of assert_().fail(...), use assertWithMessage(...).fail(). Similarly, instead of expect.fail(...), use expect.withMessage(...).fail(), and so forth.

Reports a failure with the given message.