org.fest.assertions
Class ThrowableAssert

java.lang.Object
  org.fest.assertions.Assert
      org.fest.assertions.GenericAssert<ThrowableAssert,Throwable>
          org.fest.assertions.ThrowableAssert

public class ThrowableAssert
extends GenericAssert<ThrowableAssert,Throwable>

Assertions for Throwable.

To create a new instance of this class invoke Assertions.assertThat(Throwable).

Author:

David DIDIER, Alex Ruiz

Field Summary

Fields inherited from class org.fest.assertions.GenericAssert

actual, myself

Constructor Summary

protected

ThrowableAssert(Throwable actual) Creates a new ThrowableAssert.

Method Summary

ThrowableAssert	as(Description description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
ThrowableAssert	as(String description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
ThrowableAssert	describedAs(Description description) Alias for GenericAssert.as(Description), since "as" is a keyword in Groovy.
ThrowableAssert	describedAs(String description) Alias for GenericAssert.as(String), since "as" is a keyword in Groovy.
ThrowableAssert	hasMessage(String message) Verifies that the message of the actual Throwable is equal to the given one.
ThrowableAssert	hasNoCause() Verifies that the actual Throwable does not have a cause.
ThrowableAssert	isExactlyInstanceOf(Class<?> type) Verifies that the actual Throwable is an instance of the given type.
ThrowableAssert	isInstanceOf(Class<? extends Throwable> type) Verifies that the actual Throwable is an instance of the given type.
ThrowableAssert	overridingErrorMessage(String message) Replaces the default message displayed in case of a failure with the given one.

Methods inherited from class org.fest.assertions.GenericAssert

doesNotSatisfy, is, isEqualTo, isIn, isIn, isNot, isNotEqualTo, isNotIn, isNotIn, isNotNull, isNotSameAs, isNull, isSameAs, satisfies

Methods inherited from class org.fest.assertions.Assert

customErrorMessage, description, description, description, equals, fail, fail, failIfCustomMessageIsSet, failIfCustomMessageIsSet, failure, formattedErrorMessage, hashCode, rawDescription, replaceDefaultErrorMessagesWith

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrowableAssert

protected ThrowableAssert(Throwable actual)

Creates a new ThrowableAssert.

Parameters:

actual - the target to verify.

Method Detail

isInstanceOf

public ThrowableAssert isInstanceOf(Class<? extends Throwable> type)

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

Parameters:

type - the type to check the actual Throwable against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

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

NullPointerException - if the given type is null.

isExactlyInstanceOf

public ThrowableAssert isExactlyInstanceOf(Class<?> type)

Verifies that the actual Throwable is an instance of the given type. In order for the assertion to pass, the type of the actual Throwable has to be exactly the same as the given type.

Parameters:

type - the type to check the actual Throwable against.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

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

NullPointerException - if the given type is null.

hasMessage

public ThrowableAssert hasMessage(String message)

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

Parameters:

message - the expected message.

Returns:

this assertion error.

Throws:

AssertionError - if the actual Throwable is null.

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

hasNoCause

public ThrowableAssert hasNoCause()

Verifies that the actual Throwable does not have a cause.

Returns:

this assertion object.

Throws:

AssertionError - if the actual Throwable is null.

AssertionError - if the actual Throwable has a cause.

as

public ThrowableAssert as(String description)

Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(val).as("name").isEqualTo("Frodo");
 

Overrides:

as in class GenericAssert<ThrowableAssert,Throwable>

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

describedAs

public ThrowableAssert describedAs(String description)

Alias for GenericAssert.as(String), since "as" is a keyword in Groovy. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(val).describedAs("name").isEqualTo("Frodo");
 

Overrides:

describedAs in class GenericAssert<ThrowableAssert,Throwable>

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

as

public ThrowableAssert as(Description description)

Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(val).as(new BasicDescription("name")).isEqualTo("Frodo");
 

Overrides:

as in class GenericAssert<ThrowableAssert,Throwable>

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

describedAs

public ThrowableAssert describedAs(Description description)

Alias for GenericAssert.as(Description), since "as" is a keyword in Groovy. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(val).describedAs(new BasicDescription("name")).isEqualTo("Frodo");
 

Overrides:

describedAs in class GenericAssert<ThrowableAssert,Throwable>

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

overridingErrorMessage

public ThrowableAssert overridingErrorMessage(String message)

Replaces the default message displayed in case of a failure with the given one.

For example, the following assertion:

 assertThat("Hello").isEqualTo("Bye");
 

will fail with the default message "expected:<'[Bye]'> but was:<'[Hello]'>."

We can replace this message with our own:

 assertThat("Hello").overridingErrorMessage("'Hello' should be equal to 'Bye'").isEqualTo("Bye");
 

in this case, the assertion will fail showing the message "'Hello' should be equal to 'Bye'".

Overrides:

overridingErrorMessage in class GenericAssert<ThrowableAssert,Throwable>

Parameters:

message - the given error message, which will replace the default one.

Returns:

this assertion.