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

Field Summary

Fields

Modifier and Type	Field	Description
private final FailureMetadata	metadataDoNotReferenceDirectly

Constructor Summary

Constructors

Constructor	Description
StandardSubjectBuilder(FailureMetadata metadata)

Method Summary

Modifier and Type	Method	Description
final <CustomSubjectBuilderT extends CustomSubjectBuilder> CustomSubjectBuilderT	about(CustomSubjectBuilder.Factory<CustomSubjectBuilderT> factory)
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.
(package private) void	checkStatePreconditions()	Extension point invoked before every assertion.
final void	fail()	Reports a failure.
static StandardSubjectBuilder	forCustomFailureStrategy(FailureStrategy failureStrategy)	Returns a new instance that invokes the given FailureStrategy when a check fails.
private FailureMetadata	metadata()
final PrimitiveBooleanArraySubject	that(boolean[] actual)
final PrimitiveByteArraySubject	that(byte[] actual)
final PrimitiveCharArraySubject	that(char[] actual)
final PrimitiveDoubleArraySubject	that(double[] actual)
final PrimitiveFloatArraySubject	that(float[] actual)
final PrimitiveIntArraySubject	that(int[] actual)
final PrimitiveLongArraySubject	that(long[] actual)
final PrimitiveShortArraySubject	that(short[] actual)
final GuavaOptionalSubject	that(com.google.common.base.Optional<?> actual)
final MultimapSubject	that(com.google.common.collect.Multimap<?,?> actual)
final MultisetSubject	that(com.google.common.collect.Multiset<?> actual)
final TableSubject	that(com.google.common.collect.Table<?,?,?> actual)
final <ComparableT extends Comparable<?>> ComparableSubject<ComparableT>	that(ComparableT actual)
final BooleanSubject	that(Boolean actual)
final ClassSubject	that(Class<?> actual)
final DoubleSubject	that(Double actual)
final FloatSubject	that(Float actual)
final IntegerSubject	that(Integer actual)
final IterableSubject	that(Iterable<?> actual)
final LongSubject	that(Long actual)
final Subject	that(Object actual)
final StringSubject	that(String actual)
final ThrowableSubject	that(Throwable actual)
final BigDecimalSubject	that(BigDecimal actual)
final MapSubject	that(Map<?,?> actual)
final <T> ObjectArraySubject<T>	that(T[] actual)
final StandardSubjectBuilder	withMessage(String messageToPrepend)	Returns a new instance that will output the given message before the main failure message.
final 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

Field Details

metadataDoNotReferenceDirectly

private final FailureMetadata metadataDoNotReferenceDirectly

Constructor Details

StandardSubjectBuilder

StandardSubjectBuilder(FailureMetadata metadata)

Method Details

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

that

public final BigDecimalSubject that(BigDecimal actual)

that

public final Subject that(Object actual)

that

public final ClassSubject that(Class<?> actual)

that

public final ThrowableSubject that(Throwable actual)

that

public final LongSubject that(Long actual)

that

public final DoubleSubject that(Double actual)

that

public final FloatSubject that(Float actual)

that

public final IntegerSubject that(Integer actual)

that

public final BooleanSubject that(Boolean actual)

that

public final StringSubject that(String actual)

that

public final IterableSubject that(Iterable<?> actual)

that

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

that

public final PrimitiveBooleanArraySubject that(boolean[] actual)

that

public final PrimitiveShortArraySubject that(short[] actual)

that

public final PrimitiveIntArraySubject that(int[] actual)

that

public final PrimitiveLongArraySubject that(long[] actual)

that

public final PrimitiveCharArraySubject that(char[] actual)

that

public final PrimitiveByteArraySubject that(byte[] actual)

that

public final PrimitiveFloatArraySubject that(float[] actual)

that

public final PrimitiveDoubleArraySubject that(double[] actual)

that

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

that

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

that

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

that

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

that

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

withMessage

public final StandardSubjectBuilder withMessage(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)).

metadata

private FailureMetadata metadata()

checkStatePreconditions

void checkStatePreconditions()

Extension point invoked before every assertion. This allows Expect to check that it's been set up properly as a TestRule.