com.google.common.truth

Class FailureStrategy

java.lang.Object

com.google.common.truth.FailureStrategy

Direct Known Subclasses:

AbstractFailureStrategy

public abstract class FailureStrategy
extends Object

Defines what to do when a check fails.

This type does not appear directly in a fluent assertion chain, but you choose a FailureStrategy by choosing which StandardSubjectBuilder-returning method to call.

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

For people extending Truth

Custom FailureStrategy implementations are unusual. If you think you need one, consider these alternatives:

• To test a custom subject, use ExpectFailure.
• To create subjects for other objects related to your actual value (for chained assertions), use Subject.check(), which preserves the existing FailureStrategy and other context.
• To return a no-op subject after a previous assertion has failed (for chained assertions), use Subject.ignoreCheck()

When you really do need to create your own strategy, prefer to extend AbstractFailureStrategy rather than this class directly. And rather than expose your FailureStrategy instance to users, expose a StandardSubjectBuilder instance using StandardSubjectBuilder.forCustomFailureStrategy(STRATEGY).

Constructor Summary

Constructors

Constructor and Description
FailureStrategy()

Method Summary

Modifier and Type	Method and Description
abstract void	fail(String message) Report an assertion failure with a text message.
abstract void	fail(String message, Throwable cause) Report an assertion failure with a text message and a throwable that indicates the cause of the failure.
abstract void	failComparing(String message, CharSequence expected, CharSequence actual) Convenience method to report string-comparison failures with more detail (e.g.
abstract void	failComparing(String message, CharSequence expected, CharSequence actual, Throwable cause) Convenience method to report string-comparison failures with more detail (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

FailureStrategy

public FailureStrategy()

Method Detail

fail

public abstract void fail(String message)

Report an assertion failure with a text message. This method should generally delegate to fail(String, Throwable).

fail

public abstract void fail(String message,
                          Throwable cause)

Report an assertion failure with a text message and a throwable that indicates the cause of the failure. This will be reported as the cause of the exception raised by this method (if one is thrown) or otherwise recorded by the strategy as the underlying cause of the failure.

failComparing

public abstract void failComparing(String message,
                                   CharSequence expected,
                                   CharSequence actual)

Convenience method to report string-comparison failures with more detail (e.g. character differences). This method should generally delegate to failComparing(String, CharSequence, CharSequence, Throwable).

failComparing

public abstract void failComparing(String message,
                                   CharSequence expected,
                                   CharSequence actual,
                                   Throwable cause)

Convenience method to report string-comparison failures with more detail (e.g. character differences), along with a throwable that indicates the cause of the failure. This will be reported as the cause of the exception raised by this method (if one is thrown) or otherwise recorded by the strategy as the underlying cause of the failure.