Package 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
FieldsFields inherited from class org.assertj.core.api.AbstractAssert
actual, conditions, info, myself, objects
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionVerifies that the actualThrowable
has a cause similar to the given one, that is with same type and message (it does not useequals
method for comparison).withCauseExactlyInstanceOf
(Class<? extends Throwable> type) Verifies that the cause of the actualThrowable
is exactly an instance of the given type.withCauseInstanceOf
(Class<? extends Throwable> type) Verifies that the cause of the actualThrowable
is an instance of the given type.withMessage
(String message) Verifies that the message of the actualThrowable
is equal to the given one.withMessage
(String message, Object... parameters) Verifies that the message of the actualThrowable
is equal to the given one built usingString.format(String, Object...)
syntax.withMessageContaining
(String description) Verifies that the message of the actualThrowable
contains with the given description.withMessageEndingWith
(String description) Verifies that the message of the actualThrowable
ends with the given description.withMessageMatching
(String regex) Verifies that the message of the actualThrowable
matches with the given regular expression.withMessageStartingWith
(String description) Verifies that the message of the actualThrowable
starts with the given description.Verifies that the actualThrowable
does not have a cause.withRootCauseExactlyInstanceOf
(Class<? extends Throwable> type) Verifies that the root cause of the actualThrowable
is exactly an instance of the given type.withRootCauseInstanceOf
(Class<? extends Throwable> type) Verifies that the root cause of the actualThrowable
is an instance of the given type.withStackTraceContaining
(String description) Verifies that the stack trace of the actualThrowable
contains with the given description.Methods inherited from class org.assertj.core.api.AbstractAssert
as, as, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, 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
-
Field Details
-
delegate
-
-
Constructor Details
-
ThrowableAssertAlternative
ThrowableAssertAlternative(T actual)
-
-
Method Details
-
withMessage
Verifies that the message of the actualThrowable
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 actualThrowable
isnull
.AssertionError
- if the message of the actualThrowable
is not equal to the given one.- See Also:
-
withMessage
Verifies that the message of the actualThrowable
is equal to the given one built usingString.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 messageparameters
- argument referenced by the format specifiers in the format string- Returns:
- this assertion object.
- Throws:
AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the message of the actualThrowable
is not equal to the given one.- See Also:
-
withCause
Verifies that the actualThrowable
has a cause similar to the given one, that is with same type and message (it does not useequals
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);
- Returns:
- this assertion object.
- Throws:
AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the actualThrowable
has not the given cause.- See Also:
-
withNoCause
Verifies that the actualThrowable
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 actualThrowable
isnull
.AssertionError
- if the actualThrowable
has a cause.- See Also:
-
withMessageStartingWith
Verifies that the message of the actualThrowable
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 actualThrowable
's message.- Returns:
- this assertion object.
- Throws:
AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the message of the actualThrowable
does not start with the given description.- See Also:
-
withMessageContaining
Verifies that the message of the actualThrowable
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 actualThrowable
's message.- Returns:
- this assertion object.
- Throws:
AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the message of the actualThrowable
does not contain the given description.- See Also:
-
withStackTraceContaining
Verifies that the stack trace of the actualThrowable
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 actualThrowable
's stack trace.- Returns:
- this assertion object.
- Throws:
AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the stack trace of the actualThrowable
does not contain the given description.- See Also:
-
withMessageMatching
Verifies that the message of the actualThrowable
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 actualThrowable
's message.- Returns:
- this assertion object.
- Throws:
AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the message of the actualThrowable
does not match the given regular expression.NullPointerException
- if the regex is null- See Also:
-
withMessageEndingWith
Verifies that the message of the actualThrowable
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 actualThrowable
's message.- Returns:
- this assertion object.
- Throws:
AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the message of the actualThrowable
does not end with the given description.- See Also:
-
withCauseInstanceOf
Verifies that the cause of the actualThrowable
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 isnull
.AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the actualThrowable
has no cause.AssertionError
- if the cause of the actualThrowable
is not an instance of the given type.- See Also:
-
withCauseExactlyInstanceOf
Verifies that the cause of the actualThrowable
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 isnull
.AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the actualThrowable
has no cause.AssertionError
- if the cause of the actualThrowable
is not exactly an instance of the given type.- See Also:
-
withRootCauseInstanceOf
Verifies that the root cause of the actualThrowable
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 isnull
.AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the actualThrowable
has no cause.AssertionError
- if the cause of the actualThrowable
is not an instance of the given type.- See Also:
-
withRootCauseExactlyInstanceOf
public ThrowableAssertAlternative<T> withRootCauseExactlyInstanceOf(Class<? extends Throwable> type) Verifies that the root cause of the actualThrowable
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 isnull
.AssertionError
- if the actualThrowable
isnull
.AssertionError
- if the actualThrowable
has no cause.AssertionError
- if the root cause of the actualThrowable
is not exactly an instance of the given type.- See Also:
-