com.google.common.truth

Class CustomSubjectBuilder

java.lang.Object

com.google.common.truth.CustomSubjectBuilder

Direct Known Subclasses:

ProtoSubjectBuilder

public abstract class CustomSubjectBuilder
extends Object

In a fluent assertion chain, exposes one or more "custom" that methods, which accept a value under test and return a Subject.

(Note that the "custom" that methods are not defined on CustomSubjectBuilder itself, only on its subtypes, which are the types users actually interact with.)

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

Modifier and Type	Class and Description
static interface	CustomSubjectBuilder.Factory<CustomSubjectBuilderT extends CustomSubjectBuilder> In a fluent assertion chain, the argument to the "custom" overload of about, the method that specifies what kind of Subject to create.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CustomSubjectBuilder(FailureMetadata metadata) Constructor for use by subclasses.
protected	CustomSubjectBuilder(FailureStrategy failureStrategy) Deprecated. When you switch from CustomSubjectBuilderFactory to CustomSubjectBuilder.Factory, you'll switch to using the other constructor, which accepts a FailureMetadata instead of a FailureStrategy.

Method Summary

Modifier and Type	Method and Description
protected FailureStrategy	failureStrategy() Deprecated. When you switch your Subject implementations from accepting a FailureStrategy to accepting a FailureMetadata, you'll switch from calling this method to calling metadata.
protected FailureMetadata	metadata() Returns the FailureMetadata instance that that methods should pass to Subject constructors.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomSubjectBuilder

@Deprecated
protected CustomSubjectBuilder(FailureStrategy failureStrategy)

Deprecated. When you switch from CustomSubjectBuilderFactory to CustomSubjectBuilder.Factory, you'll switch to using the other constructor, which accepts a FailureMetadata instead of a FailureStrategy.

CustomSubjectBuilder

protected CustomSubjectBuilder(FailureMetadata metadata)

Constructor for use by subclasses.

Method Detail

failureStrategy

@Deprecated
protected final FailureStrategy failureStrategy()

Deprecated. When you switch your Subject implementations from accepting a FailureStrategy to accepting a FailureMetadata, you'll switch from calling this method to calling metadata.

metadata

protected final FailureMetadata metadata()

Returns the FailureMetadata instance that that methods should pass to Subject constructors.