Package org.apache.juneau.assertions

Class ThrowableAssertion<T extends Throwable>

java.lang.Object

org.apache.juneau.assertions.Assertion

org.apache.juneau.assertions.FluentAssertion<R>

org.apache.juneau.assertions.FluentObjectAssertion<T,R>

org.apache.juneau.assertions.FluentThrowableAssertion<T,ThrowableAssertion<T>>

org.apache.juneau.assertions.ThrowableAssertion<T>

Type Parameters:

T - The throwable type.

public class ThrowableAssertion<T extends Throwable>
extends FluentThrowableAssertion<T,ThrowableAssertion<T>>

Used for assertion calls against throwable objects.

Example:

// Validates the throwable message or one of the parent messages contain 'Foobar'. assertThrowable(throwable).contains("Foobar");

Test Methods:

• FluentObjectAssertion
  • isExists()
  • is(Object)
  • is(Predicate)
  • isNot(Object)
  • isAny(Object...)
  • isNotAny(Object...)
  • isNull()
  • isNotNull()
  • isString(String)
  • isJson(String)
  • isSame(Object)
  • isSameJsonAs(Object)
  • isSameSortedJsonAs(Object)
  • isSameSerializedAs(Object, WriterSerializer)
  • isType(Class)
  • isExactType(Class)

Transform Methods:

• FluentThrowableAssertion
  • asMessage()
  • asMessages()
  • asLocalizedMessage()
  • asLocalizedMessages()
  • asStackTrace()
  • asCausedBy()
  • asCausedBy(Class)
  • asFind(Class)
• FluentObjectAssertion
  • asString()
  • asString(WriterSerializer)
  • asString(Function)
  • asJson()
  • asJsonSorted()
  • asApplied(Function)
  • asAny()

Configuration Methods:

• Assertion
  • setMsg(String, Object...)
  • setOut(PrintStream)
  • setSilent()
  • setStdOut()
  • setThrowable(Class)

See Also:

• Juneau Ecosystem Overview

Constructor Summary

Constructors

Constructor	Description
ThrowableAssertion(T value)	Constructor.

Method Summary

Modifier and Type	Method	Description
static <X extends Throwable> ThrowableAssertion<X>	create(X value)	Static creator.
ThrowableAssertion<T>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
ThrowableAssertion<T>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
ThrowableAssertion<T>	setSilent()	Suppresses output to STDERR.
ThrowableAssertion<T>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
ThrowableAssertion<T>	setThrowable(Class<? extends RuntimeException> value)	If an error occurs, throw this exception instead of the standard AssertionError.

Methods inherited from class org.apache.juneau.assertions.FluentThrowableAssertion

asCausedBy, asCausedBy, asFind, asLocalizedMessage, asLocalizedMessages, asMessage, asMessages, asStackTrace, asTransformed, equals, isExactType, isExists, isType

Methods inherited from class org.apache.juneau.assertions.FluentObjectAssertion

asAny, asJson, asJsonSorted, asString, asString, asString, asTransformedTo, getFailureMessage, is, is, isAny, isJson, isNot, isNotAny, isNotNull, isNull, isSame, isSameJsonAs, isSameSerializedAs, isSameSortedJsonAs, isString, map, opt, orElse, toString, value, valueAsString, valueIsNotNull, valueIsNull

Methods inherited from class org.apache.juneau.assertions.FluentAssertion

returns

Methods inherited from class org.apache.juneau.assertions.Assertion

arrayClass, error, error

Methods inherited from class java.lang.Object

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

Constructor Details

ThrowableAssertion

public ThrowableAssertion(T value)

Constructor.

Parameters:

value - The object being tested.
Can be null.

Method Details

create

public static <X extends Throwable>
ThrowableAssertion<X> create(X value)

Static creator.

Type Parameters:

X - The throwable type.

Parameters:

value - The object being tested.
Can be null.

Returns:

A new assertion object.

setMsg

public ThrowableAssertion<T> setMsg(String msg,
 Object... args)

Description copied from class: Assertion

Allows you to override the assertion failure message.

String can contain "{msg}" to represent the original message.

Example:

import static org.apache.juneau.assertions.Assertions.*; // Throws an assertion with a custom message instead of the default "Value was null." assertString(myString) .setMsg("My string was bad: {msg}") .isNotNull();

Overrides:

setMsg in class FluentThrowableAssertion<T extends Throwable,ThrowableAssertion<T extends Throwable>>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public ThrowableAssertion<T> setOut(PrintStream value)

Description copied from class: Assertion

If an error occurs, send the error message to the specified stream instead of STDERR.

Overrides:

setOut in class FluentThrowableAssertion<T extends Throwable,ThrowableAssertion<T extends Throwable>>

Parameters:

value - The output stream. Can be null to suppress output.

Returns:

This object.

setSilent

public ThrowableAssertion<T> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentThrowableAssertion<T extends Throwable,ThrowableAssertion<T extends Throwable>>

Returns:

This object.

setStdOut

public ThrowableAssertion<T> setStdOut()

Description copied from class: Assertion

If an error occurs, send the error message to STDOUT instead of STDERR.

Overrides:

setStdOut in class FluentThrowableAssertion<T extends Throwable,ThrowableAssertion<T extends Throwable>>

Returns:

This object.

setThrowable

public ThrowableAssertion<T> setThrowable(Class<? extends RuntimeException> value)

Description copied from class: Assertion

If an error occurs, throw this exception instead of the standard AssertionError.

The throwable class must have a public constructor that takes in any of the following parameters:

• Throwable - The caused-by exception (if there is one).
• String - The assertion failure message.

If the throwable cannot be instantiated, a RuntimeException is thrown instead.

Example:

import static org.apache.juneau.assertions.Assertions.*; // Throws a BadRequest instead of an AssertionError if the string is null. assertString(myString) .setThrowable(BadRequest.class) .isNotNull();

Overrides:

setThrowable in class FluentThrowableAssertion<T extends Throwable,ThrowableAssertion<T extends Throwable>>

Parameters:

value - The new value for this setting.

Returns:

This object.