com.google.common.truth

Class AbstractVerb<T extends AbstractVerb<T>>

java.lang.Object

com.google.common.truth.FailureContext

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

Direct Known Subclasses:

TestVerb

public abstract class AbstractVerb<T extends AbstractVerb<T>>
extends FailureContext

A parent type for some infrastructure used in the Verb.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractVerb.DelegatedVerb<S extends Subject<S,T>,T> A special Verb implementation which wraps a SubjectFactory
protected static class	AbstractVerb.MessagePrependingFailureStrategy

Constructor Summary

Constructors

Constructor and Description
AbstractVerb(FailureStrategy failureStrategy)
AbstractVerb(FailureStrategy failureStrategy, String format, Object... args)

Method Summary

Modifier and Type	Method and Description
<V extends AbstractDelegatedVerb<V>> V	about(DelegatedVerbFactory<V> factory) A generic, advanced method of extension of Truth to new types, which is documented on DelegatedVerbFactory.
<S extends Subject<S,D>,D,SF extends SubjectFactory<S,D>> AbstractVerb.DelegatedVerb<S,D>	about(SF factory) The recommended method of extension of Truth to new types, which is documented in com.google.common.truth.delegation.DelegationTest.
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
protected FailureStrategy	getFailureStrategy()
abstract T	withFailureMessage(String failureMessage) Deprecated. Use withMessage, the new name of this method.
abstract T	withFailureMessage(String format, Object... args) Deprecated. Use withMessage, the new name of this method.
abstract T	withMessage(String messageToPrepend) Overrides the failure message of the subsequent subject's propositions.
abstract T	withMessage(String format, Object... args) Overrides the failure message of the subsequent subject's propositions.

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

Constructor Detail

AbstractVerb

public AbstractVerb(FailureStrategy failureStrategy)

AbstractVerb

public AbstractVerb(FailureStrategy failureStrategy,
                    @Nullable
                    String format,
                    Object... args)

Method Detail

getFailureStrategy

protected FailureStrategy getFailureStrategy()

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

withFailureMessage

@Deprecated
public abstract T withFailureMessage(@Nullable
                                                 String failureMessage)

Deprecated. Use withMessage, the new name of this method.

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

Parameters:

failureMessage - 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

withFailureMessage

@Deprecated
public abstract T withFailureMessage(@Nullable
                                                 String format,
                                                 Object... args)

Deprecated. Use withMessage, the new name of this method.

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

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.

See Also:

com.google.common.truth.delegation.DelegationTest

withMessage

public abstract T withMessage(@Nullable
                              String messageToPrepend)

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

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 abstract T withMessage(@Nullable
                              String format,
                              Object... args)

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

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.

See Also:

com.google.common.truth.delegation.DelegationTest

about

public final <S extends Subject<S,D>,D,SF extends SubjectFactory<S,D>> AbstractVerb.DelegatedVerb<S,D> about(SF factory)

The recommended method of extension of Truth to new types, which is documented in com.google.common.truth.delegation.DelegationTest.

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 <V extends AbstractDelegatedVerb<V>> V about(DelegatedVerbFactory<V> factory)

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

Type Parameters:

V - the type of AbstractDelegatedVerb to return

Parameters:

factory - a DelegatedVerbFactory<V> implementation

Returns:

A custom verb of type <V>