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(SubjectFactory).
• For the types of Subject built into Truth, directly specify the value under test with that(Object).

TODO(cpovirk): Link to a doc about the full assertion chain.

For people extending Truth

TODO(cpovirk): Link to a doc about custom subjects.

Method Summary

Modifier and Type	Method and Description
<CustomSubjectBuilderT extends CustomSubjectBuilder> CustomSubjectBuilderT	about(CustomSubjectBuilder.Factory<CustomSubjectBuilderT> factory)
<CustomSubjectBuilderT extends CustomSubjectBuilder> CustomSubjectBuilderT	about(CustomSubjectBuilderFactory<CustomSubjectBuilderT> factory) Deprecated. When you switch from CustomSubjectBuilderFactory to CustomSubjectBuilder.Factory, you'll switch from this overload to the CustomSubjectBuilder.Factory overload.
<S extends Subject<S,A>,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.
<S extends Subject<S,A>,A> SimpleSubjectBuilder<S,A>	about(SubjectFactory<S,A> factory) Deprecated. When you switch from SubjectFactory to Subject.Factory, you'll switch from this overload to the Subject.Factory overload.
void	fail() Triggers the failure strategy with an empty failure message
void	fail(String format, Object... args) Triggers the failure strategy with the given failure message
static StandardSubjectBuilder	forCustomFailureStrategy(FailureStrategy failureStrategy) Returns a new instance that invokes the given FailureStrategy when a check fails.
AtomicLongMapSubject	that(com.google.common.util.concurrent.AtomicLongMap<?> actual)
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)
ListMultimapSubject	that(com.google.common.collect.ListMultimap<?,?> actual)
LongSubject	that(Long actual)
PrimitiveLongArraySubject	that(long[] actual)
MapSubject	that(Map<?,?> actual)
MultimapSubject	that(com.google.common.collect.Multimap<?,?> actual)
MultisetSubject	that(com.google.common.collect.Multiset<?> actual)
Subject<DefaultSubject,Object>	that(Object actual)
GuavaOptionalSubject	that(com.google.common.base.Optional<?> actual)
SetMultimapSubject	that(com.google.common.collect.SetMultimap<?,?> actual)
PrimitiveShortArraySubject	that(short[] actual)
SortedMapSubject	that(SortedMap<?,?> actual)
SortedSetSubject	that(SortedSet<?> actual)
StringSubject	that(String actual)
<T> ObjectArraySubject<T>	that(T[] actual)
TableSubject	that(com.google.common.collect.Table<?,?,?> actual)
ThrowableSubject	that(Throwable actual)
StandardSubjectBuilder	withMessage(String messageToPrepend)
StandardSubjectBuilder	withMessage(String format, Object... args) Returns a StandardSubjectBuilder that will prepend the formatted message using the specified arguments to the failure message in the event of a test failure.

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

that

public final BigDecimalSubject that(@Nullable
                                    BigDecimal actual)

that

public final Subject<DefaultSubject,Object> that(@Nullable
                                                 Object actual)

that

@GwtIncompatible(value="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 SortedSetSubject that(@Nullable
                                   SortedSet<?> actual)

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

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

that

public final GuavaOptionalSubject that(@Nullable
                                       com.google.common.base.Optional<?> actual)

that

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

that

public final SortedMapSubject that(@Nullable
                                   SortedMap<?,?> actual)

that

public final MultimapSubject that(@Nullable
                                  com.google.common.collect.Multimap<?,?> actual)

that

public final ListMultimapSubject that(@Nullable
                                      com.google.common.collect.ListMultimap<?,?> actual)

that

public final SetMultimapSubject that(@Nullable
                                     com.google.common.collect.SetMultimap<?,?> actual)

that

public final MultisetSubject that(@Nullable
                                  com.google.common.collect.Multiset<?> actual)

that

public final TableSubject that(@Nullable
                               com.google.common.collect.Table<?,?,?> actual)

that

public final AtomicLongMapSubject that(@Nullable
                                       com.google.common.util.concurrent.AtomicLongMap<?> actual)

withMessage

public final StandardSubjectBuilder withMessage(@Nullable
                                                String messageToPrepend)

withMessage

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

Returns a StandardSubjectBuilder that will prepend the formatted message using the specified arguments to the failure message in the event of a test failure.

Note: The failure message template string only supports the "%s" specifier, not the full range of Formatter specifiers.

Throws:

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

about

@Deprecated
public final <S extends Subject<S,A>,A> SimpleSubjectBuilder<S,A> about(SubjectFactory<S,A> factory)

Deprecated. When you switch from SubjectFactory to Subject.Factory, you'll switch from this overload to the Subject.Factory overload.

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 <S extends Subject<S,A>,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

@Deprecated
public final <CustomSubjectBuilderT extends CustomSubjectBuilder> CustomSubjectBuilderT about(CustomSubjectBuilderFactory<CustomSubjectBuilderT> factory)

Deprecated. When you switch from CustomSubjectBuilderFactory to CustomSubjectBuilder.Factory, you'll switch from this overload to the CustomSubjectBuilder.Factory overload.

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

about

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

fail

public final void fail()

Triggers the failure strategy with an empty failure message

fail

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

Triggers the failure strategy with the given failure message