uk.org.lidalia.test

Class ShouldThrow

java.lang.Object

uk.org.lidalia.test.ShouldThrow

public final class ShouldThrow
extends Object

Static functions for returning an expected type of Throwable from a block of code for unit testing purposes.

Method Summary

Methods

Modifier and Type	Method and Description
static <ThrowableType extends Throwable> ThrowableType	shouldThrow(Class<ThrowableType> expectedThrowableType, Runnable workThatShouldThrowThrowable) Asserts that a code block throws a Throwable of the given type and returns it to permit further assertions on the Throwable instance returned.
static <ThrowableType extends Throwable> ThrowableType	shouldThrow(Class<ThrowableType> expectedThrowableType, String message, Runnable workThatShouldThrowThrowable) Asserts that a code block throws a Throwable of the given type and returns it to permit further assertions on the Throwable instance returned.

Methods inherited from class java.lang.Object

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

Method Detail

shouldThrow

public static <ThrowableType extends Throwable> ThrowableType shouldThrow(Class<ThrowableType> expectedThrowableType,
                                                          Runnable workThatShouldThrowThrowable)

Asserts that a code block throws a Throwable of the given type and returns it to permit further assertions on the Throwable instance returned.

Type Parameters:

ThrowableType - the type of the throwable the code block should throw

Parameters:

expectedThrowableType - the class of the throwable the code block should throw

workThatShouldThrowThrowable - a code block that ought to throw the expected type when evaluated

Returns:

the instance of the expected throwable type thrown by the code block, if it was thrown

Throws:

AssertionError - if no Throwable is thrown at all whilst executing the code block

Throwable - any other Throwable thrown by the code block that is not an instance of the expected type

shouldThrow

public static <ThrowableType extends Throwable> ThrowableType shouldThrow(Class<ThrowableType> expectedThrowableType,
                                                          String message,
                                                          Runnable workThatShouldThrowThrowable)

Asserts that a code block throws a Throwable of the given type and returns it to permit further assertions on the Throwable instance returned.

Type Parameters:

ThrowableType - the type of the throwable the code block should throw

Parameters:

expectedThrowableType - the class of the throwable the code block should throw

message - the message to be used as the message of the AssertionError if no throwable is thrown at all

workThatShouldThrowThrowable - a code block that ought to throw the expected type when evaluated

Returns:

the instance of the expected throwable type thrown by the code block, if it was thrown

Throws:

AssertionError - if no Throwable is thrown at all whilst executing the code block

Throwable - any other Throwable thrown by the code block that is not an instance of the expected type