com.google.common.truth

Class StandardSubjectBuilder

java.lang.Object

com.google.common.truth.FailureContext

com.google.common.truth.AbstractVerb<TestVerb>

com.google.common.truth.TestVerb

com.google.common.truth.StandardSubjectBuilder

Direct Known Subclasses:

Expect

public class StandardSubjectBuilder
extends TestVerb

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.truth.AbstractVerb

AbstractVerb.DelegatedVerb<S extends Subject<S,T>,T>

Method Summary

Modifier and Type	Method and Description
<CustomSubjectBuilderT extends CustomSubjectBuilder> CustomSubjectBuilderT	about(CustomSubjectBuilderFactory<CustomSubjectBuilderT> factory) A generic, advanced method of extension of Truth to new types, which is documented on CustomSubjectBuilder.
<S extends Subject<S,A>,A,SF extends SubjectFactory<S,A>> SimpleSubjectBuilder<S,A>	about(SF factory) Given a factory for some Subject class, returns a builder whose that(actual) method creates instances of that class.
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<?> target)
BigDecimalSubject	that(BigDecimal target)
BooleanSubject	that(Boolean target)
PrimitiveBooleanArraySubject	that(boolean[] target)
PrimitiveByteArraySubject	that(byte[] target)
PrimitiveCharArraySubject	that(char[] target)
ClassSubject	that(Class<?> target)
DoubleSubject	that(Double target)
PrimitiveDoubleArraySubject	that(double[] target)
FloatSubject	that(Float target)
PrimitiveFloatArraySubject	that(float[] target)
PrimitiveIntArraySubject	that(int[] target)
IntegerSubject	that(Integer target)
IterableSubject	that(Iterable<?> target)
ListMultimapSubject	that(com.google.common.collect.ListMultimap<?,?> target)
LongSubject	that(Long target)
PrimitiveLongArraySubject	that(long[] target)
MapSubject	that(Map<?,?> target)
MultimapSubject	that(com.google.common.collect.Multimap<?,?> target)
MultisetSubject	that(com.google.common.collect.Multiset<?> target)
Subject<DefaultSubject,Object>	that(Object target)
GuavaOptionalSubject	that(com.google.common.base.Optional<?> target)
SetMultimapSubject	that(com.google.common.collect.SetMultimap<?,?> target)
PrimitiveShortArraySubject	that(short[] target)
SortedMapSubject	that(SortedMap<?,?> target)
SortedSetSubject	that(SortedSet<?> target)
StringSubject	that(String target)
<T extends Comparable<?>> ComparableSubject<?,T>	that(T target)
<T> ObjectArraySubject<T>	that(T[] target)
TableSubject	that(com.google.common.collect.Table<?,?,?> target)
ThrowableSubject	that(Throwable target)
StandardSubjectBuilder	withMessage(String messageToPrepend) Overrides the failure message of the subsequent subject's propositions.
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 com.google.common.truth.AbstractVerb

about, getFailureStrategy

Methods inherited from class com.google.common.truth.FailureContext

getFailureMessage, hasFailureMessage

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 <T extends Comparable<?>> ComparableSubject<?,T> that(@Nullable
                                                                   T target)

Overrides:

that in class TestVerb

that

public final BigDecimalSubject that(@Nullable
                                    BigDecimal target)

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

public final ThrowableSubject that(@Nullable
                                   Throwable target)

Overrides:

that in class TestVerb

that

public final LongSubject that(@Nullable
                              Long target)

Overrides:

that in class TestVerb

that

public final DoubleSubject that(@Nullable
                                Double target)

Overrides:

that in class TestVerb

that

public final FloatSubject that(@Nullable
                               Float target)

Overrides:

that in class TestVerb

that

public final IntegerSubject that(@Nullable
                                 Integer target)

Overrides:

that in class TestVerb

that

public final BooleanSubject that(@Nullable
                                 Boolean target)

Overrides:

that in class TestVerb

that

public final StringSubject that(@Nullable
                                String target)

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

public final SortedSetSubject that(@Nullable
                                   SortedSet<?> target)

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

that

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

Overrides:

that in class TestVerb

withMessage

public final StandardSubjectBuilder withMessage(@Nullable
                                                String messageToPrepend)

Description copied from class: AbstractVerb

Overrides the failure message of the subsequent subject's propositions.

Overrides:

withMessage in class TestVerb

Parameters:

messageToPrepend - a descriptive message.

Returns:

A custom verb which will show the descriptive message along with the normal failure text.

See Also:

com.google.common.truth.delegation.DelegationTest

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.

Overrides:

withMessage in class TestVerb

Parameters:

format - a descriptive message with formatting template content.

args - object parameters to be substituted into the message template.

Returns:

A custom verb which will show the descriptive message along with the normal failure text.

Throws:

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

See Also:

com.google.common.truth.delegation.DelegationTest

about

public final <S extends Subject<S,A>,A,SF extends SubjectFactory<S,A>> SimpleSubjectBuilder<S,A> about(SF 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.

Overrides:

about in class AbstractVerb<TestVerb>

Parameters:

factory - a SubjectFactory<S, D> implementation

Returns:

A custom verb for the type returned by the SubjectFactory

See Also:

com.google.common.truth.delegation.DelegationTest

about

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

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

fail

public final void fail()

Triggers the failure strategy with an empty failure message

Overrides:

fail in class AbstractVerb<TestVerb>

fail

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

Triggers the failure strategy with the given failure message

Overrides:

fail in class AbstractVerb<TestVerb>