org.assertj.core.api

Class ThrowableAssertAlternative<T extends Throwable>

java.lang.Object

org.assertj.core.api.AbstractAssert<ThrowableAssertAlternative<T>,T>

org.assertj.core.api.ThrowableAssertAlternative<T>

All Implemented Interfaces:

Assert<ThrowableAssertAlternative<T>,T>, Descriptable<ThrowableAssertAlternative<T>>, ExtensionPoints<ThrowableAssertAlternative<T>,T>

public class ThrowableAssertAlternative<T extends Throwable>
extends AbstractAssert<ThrowableAssertAlternative<T>,T>

Assertion methods for Throwable similar to ThrowableAssert but with assertions methods named differently to make testing code fluent (ex : withMessage instead of hasMessage.

 assertThatExceptionOfType(IOException.class)
           .isThrownBy(() -> { throw new IOException("boom! tcha!"); });
           .withMessage("boom! %s", "tcha!"); 

This class is linked with the ThrowableTypeAssert and allow to check that an exception type is thrown by a lambda.

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself, throwUnsupportedExceptionOnEquals

Method Summary

Modifier and Type	Method and Description
ThrowableAssertAlternative<T>	describedAs(Description description) Sets the description of the assertion that is going to be called after.
ThrowableAssertAlternative<T>	describedAs(String description, Object... args) Sets the description of the assertion that is going to be called after.
ThrowableAssertAlternative<T>	withCause(Throwable cause) Verifies that the actual Throwable has a cause similar to the given one, that is with same type and message (it does not use equals method for comparison).
ThrowableAssertAlternative<T>	withCauseExactlyInstanceOf(Class<? extends Throwable> type) Verifies that the cause of the actual Throwable is exactly an instance of the given type.
ThrowableAssertAlternative<T>	withCauseInstanceOf(Class<? extends Throwable> type) Verifies that the cause of the actual Throwable is an instance of the given type.
ThrowableAssertAlternative<T>	withMessage(String message) Verifies that the message of the actual Throwable is equal to the given one.
ThrowableAssertAlternative<T>	withMessage(String message, Object... parameters) Verifies that the message of the actual Throwable is equal to the given one built using String.format(String, Object...) syntax.
ThrowableAssertAlternative<T>	withMessageContaining(String description) Verifies that the message of the actual Throwable contains with the given description.
ThrowableAssertAlternative<T>	withMessageEndingWith(String description) Verifies that the message of the actual Throwable ends with the given description.
ThrowableAssertAlternative<T>	withMessageMatching(String regex) Verifies that the message of the actual Throwable matches with the given regular expression.
ThrowableAssertAlternative<T>	withMessageStartingWith(String description) Verifies that the message of the actual Throwable starts with the given description.
ThrowableAssertAlternative<T>	withNoCause() Verifies that the actual Throwable does not have a cause.
ThrowableAssertAlternative<T>	withRootCauseExactlyInstanceOf(Class<? extends Throwable> type) Verifies that the root cause of the actual Throwable is exactly an instance of the given type.
ThrowableAssertAlternative<T>	withRootCauseInstanceOf(Class<? extends Throwable> type) Verifies that the root cause of the actual Throwable is an instance of the given type.
ThrowableAssertAlternative<T>	withStackTraceContaining(String description) Verifies that the stack trace of the actual Throwable contains with the given description.

Methods inherited from class org.assertj.core.api.AbstractAssert

as, as, asList, asString, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, inBinary, inHexadecimal, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, overridingErrorMessage, satisfies, setCustomRepresentation, throwAssertionError, usingComparator, usingDefaultComparator, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Method Detail

withMessage

public ThrowableAssertAlternative<T> withMessage(String message)

Verifies that the message of the actual Throwable is equal to the given one.

Examples:

 Throwable illegalArgumentException = new IllegalArgumentException("wrong amount 123");

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessage("wrong amount 123");

 // assertion will fail
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessage("wrong amount 123 euros");

Parameters:

message - the expected message.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the message of the actual Throwable is not equal to the given one.

See Also:

AbstractThrowableAssert.hasMessage(String)

withMessage

public ThrowableAssertAlternative<T> withMessage(String message,
                                                 Object... parameters)

Verifies that the message of the actual Throwable is equal to the given one built using String.format(String, Object...) syntax.

Examples:

 Throwable illegalArgumentException = new IllegalArgumentException("wrong amount 123");

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessage("wrong amount %s, "123");

 // assertion will fail
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessage("wrong amount 123 euros");

Parameters:

message - a format string representing the expected message

parameters - argument referenced by the format specifiers in the format string

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the message of the actual Throwable is not equal to the given one.

See Also:

AbstractThrowableAssert.hasMessage(String)

withCause

public ThrowableAssertAlternative<T> withCause(Throwable cause)

Verifies that the actual Throwable has a cause similar to the given one, that is with same type and message (it does not use equals method for comparison).

Example:

 Throwable illegalArgumentException = new IllegalArgumentException("invalid arg");
 Throwable wrappingException = new Throwable(illegalArgumentException);

 // This assertion succeeds:
 
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw wrappingException;})
           .withCause(illegalArgumentException);

 // These assertions fail:
 
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw wrappingException;})
           .withCause(new IllegalArgumentException("bad arg"));
           
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw wrappingException;})
           .withCause(new NullPointerException());
           
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw wrappingException;})
           .withCause(null);

Parameters:

cause - the expected cause.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the actual Throwable has not the given cause.

See Also:

AbstractThrowableAssert.hasCause(Throwable)

withNoCause

public ThrowableAssertAlternative<T> withNoCause()

Verifies that the actual Throwable does not have a cause.

Example:

 IllegalArgumentException exception = new IllegalArgumentException();

 // This assertion succeeds:
 assertThatExceptionOfType(IllegalArgumentException.class)
           .isThrownBy(() -> {throw exception;})
           .withNoCause();

 // These assertion fails:
 Throwable illegalArgumentException = new Throwable(exception); 
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withNoCause();

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the actual Throwable has a cause.

See Also:

AbstractThrowableAssert.hasNoCause()

withMessageStartingWith

public ThrowableAssertAlternative<T> withMessageStartingWith(String description)

Verifies that the message of the actual Throwable starts with the given description.

Examples:

 Throwable illegalArgumentException = new IllegalArgumentException("wrong amount 123");

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessageStartingWith("wrong amount");

 // assertion will fail
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessageStartingWith("right amount");

Parameters:

description - the description expected to start the actual Throwable's message.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the message of the actual Throwable does not start with the given description.

See Also:

AbstractThrowableAssert.hasMessageStartingWith(String)

withMessageContaining

public ThrowableAssertAlternative<T> withMessageContaining(String description)

Verifies that the message of the actual Throwable contains with the given description.

Examples:

 Throwable illegalArgumentException = new IllegalArgumentException("wrong amount 123");

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessageContaining("amount");

 // assertion will fail
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessageContaining("456");

Parameters:

description - the description expected to be contained in the actual Throwable's message.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the message of the actual Throwable does not contain the given description.

See Also:

AbstractThrowableAssert.hasMessageContaining(String)

withStackTraceContaining

public ThrowableAssertAlternative<T> withStackTraceContaining(String description)

Verifies that the stack trace of the actual Throwable contains with the given description.

Examples:

 Throwable illegalArgumentException = new IllegalArgumentException("wrong amount 123");

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withStackTraceContaining("amount");

 // assertion will fail
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withStackTraceContaining("456");

Parameters:

description - the description expected to be contained in the actual Throwable's stack trace.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the stack trace of the actual Throwable does not contain the given description.

See Also:

AbstractThrowableAssert.hasStackTraceContaining(String)

withMessageMatching

public ThrowableAssertAlternative<T> withMessageMatching(String regex)

Verifies that the message of the actual Throwable matches with the given regular expression.

Examples:

 Throwable illegalArgumentException = new IllegalArgumentException("wrong amount 123");

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessageMatching("wrong amount [0-9]*");

 // assertion will fail
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessageMatching("wrong amount [0-9]* euros");

Parameters:

regex - the regular expression of value expected to be matched the actual Throwable's message.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the message of the actual Throwable does not match the given regular expression.

NullPointerException - if the regex is null

See Also:

AbstractThrowableAssert.hasMessageMatching(String)

withMessageEndingWith

public ThrowableAssertAlternative<T> withMessageEndingWith(String description)

Verifies that the message of the actual Throwable ends with the given description.

Examples:

 Throwable illegalArgumentException = new IllegalArgumentException("wrong amount 123");

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessageEndingWith("123");

 // assertion will fail
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw illegalArgumentException;})
           .withMessageEndingWith("456");

Parameters:

description - the description expected to end the actual Throwable's message.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the message of the actual Throwable does not end with the given description.

See Also:

AbstractThrowableAssert.hasMessageEndingWith(String)

withCauseInstanceOf

public ThrowableAssertAlternative<T> withCauseInstanceOf(Class<? extends Throwable> type)

Verifies that the cause of the actual Throwable is an instance of the given type.

Example:

 Throwable throwable = new Throwable(new NullPointerException());

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withCauseInstanceOf(NullPointerException.class);
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withCauseInstanceOf(RuntimeException.class);

 // assertion will fail
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withCauseInstanceOf(IllegalArgumentException.class);

Parameters:

type - the expected cause type.

Returns:

this assertion object.

Throws:

NullPointerException - if given type is null.

AssertionError - if the actual Throwable is null.

AssertionError - if the actual Throwable has no cause.

AssertionError - if the cause of the actual Throwable is not an instance of the given type.

See Also:

AbstractThrowableAssert.hasCauseInstanceOf(Class)

withCauseExactlyInstanceOf

public ThrowableAssertAlternative<T> withCauseExactlyInstanceOf(Class<? extends Throwable> type)

Verifies that the cause of the actual Throwable is exactly an instance of the given type.

Example:

 Throwable throwable = new Throwable(new NullPointerException());

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withCauseExactlyInstanceOf(NullPointerException.class);

 // assertions will fail (even if NullPointerException is a RuntimeException since we want an exact match)
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withCauseExactlyInstanceOf(RuntimeException.class);
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withCauseExactlyInstanceOf(IllegalArgumentException.class);

Parameters:

type - the expected cause type.

Returns:

this assertion object.

Throws:

NullPointerException - if given type is null.

AssertionError - if the actual Throwable is null.

AssertionError - if the actual Throwable has no cause.

AssertionError - if the cause of the actual Throwable is not exactly an instance of the given type.

See Also:

AbstractThrowableAssert.hasCauseExactlyInstanceOf(Class)

withRootCauseInstanceOf

public ThrowableAssertAlternative<T> withRootCauseInstanceOf(Class<? extends Throwable> type)

Verifies that the root cause of the actual Throwable is an instance of the given type.

Example:

 Throwable throwable = new Throwable(
                            new IllegalStateException(
                                new NullPointerException()));

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withRootCauseInstanceOf(NullPointerException.class);
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withRootCauseInstanceOf(RuntimeException.class);

 // assertion will fail
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withRootCauseInstanceOf(IllegalStateException.class);

Parameters:

type - the expected cause type.

Returns:

this assertion object.

Throws:

NullPointerException - if given type is null.

AssertionError - if the actual Throwable is null.

AssertionError - if the actual Throwable has no cause.

AssertionError - if the cause of the actual Throwable is not an instance of the given type.

See Also:

AbstractThrowableAssert.hasRootCauseInstanceOf(Class)

withRootCauseExactlyInstanceOf

public ThrowableAssertAlternative<T> withRootCauseExactlyInstanceOf(Class<? extends Throwable> type)

Verifies that the root cause of the actual Throwable is exactly an instance of the given type.

Example:

 Throwable throwable = new Throwable(
                            new IllegalStateException(
                                new NullPointerException()));

 // assertion will pass
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withRootCauseExactlyInstanceOf(NullPointerException.class);

 // assertion will fail (even if NullPointerException is a RuntimeException since we want an exact match)
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withRootCauseExactlyInstanceOf(RuntimeException.class);
 assertThatExceptionOfType(Throwable.class)
           .isThrownBy(() -> {throw throwable;})
           .withRootCauseExactlyInstanceOf(IllegalStateException.class);

Parameters:

type - the expected cause type.

Returns:

this assertion object.

Throws:

NullPointerException - if given type is null.

AssertionError - if the actual Throwable is null.

AssertionError - if the actual Throwable has no cause.

AssertionError - if the root cause of the actual Throwable is not exactly an instance of the given type.

See Also:

AbstractThrowableAssert.hasRootCauseExactlyInstanceOf(Class)

describedAs

public ThrowableAssertAlternative<T> describedAs(String description,
                                                 Object... args)

Sets the description of the assertion that is going to be called after.

You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.

Alias for Descriptable.as(String, Object...) since "as" is a keyword in Groovy.

Specified by:

describedAs in interface Descriptable<ThrowableAssertAlternative<T extends Throwable>>

Overrides:

describedAs in class AbstractAssert<ThrowableAssertAlternative<T extends Throwable>,T extends Throwable>

Parameters:

description - the new description to set.

args - optional parameter if description is a format String.

Returns:

this object.

describedAs

public ThrowableAssertAlternative<T> describedAs(Description description)

Sets the description of the assertion that is going to be called after.

You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.

This overloaded version of "describedAs" offers more flexibility than the one taking a String by allowing users to pass their own implementation of a description. For example, a description that creates its value lazily, only when an assertion failure occurs.

Specified by:

describedAs in interface Descriptable<ThrowableAssertAlternative<T extends Throwable>>

Overrides:

describedAs in class AbstractAssert<ThrowableAssertAlternative<T extends Throwable>,T extends Throwable>

Parameters:

description - the new description to set.

Returns:

this object.