net.sf.mmm.test

Class ExceptionHelper

java.lang.Object

net.sf.mmm.test.ExceptionHelper

public final class ExceptionHelper
extends Object

This is a utility-class with static methods that help to write negative-tests that check expected exceptions.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOGGER The Logger instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ExceptionHelper() The constructor.

Method Summary

Modifier and Type	Method and Description
static <T extends Throwable> T	assertCause(Throwable catched, Class<T> expectedType) This method should be invoked in catch-block of tests that catched a given exception and expect that this exception or one of its causes are an instance of the given expectedType.
static void	assertCause(Throwable catched, Throwable expectedCause) This method should be invoked in catch-block of tests that catched a given exception and expect that this exception or one of its causes is the same as the given expectedCause.
static void	failExceptionExpected() This method should be invoked in try-blocks of tests that expect an exception to be thrown.
static <T extends Throwable> T	getCause(Throwable catched, Class<T> expectedType) This method gets a catched exception or one of its causes that is an instance of the given expectedType.
static boolean	isCause(Throwable catched, Class<? extends Throwable> expectedType) This method checks if a catched exception or one of its causes is an instance of the given expectedType.
static boolean	isCause(Throwable catched, Throwable expectedCause) This method should be invoked in catch-block of tests that catched a given exception and expect that this exception or one of its causes is the same as the given expectedCause.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

The Logger instance.

Constructor Detail

ExceptionHelper

private ExceptionHelper()

The constructor.

Method Detail

failExceptionExpected

public static void failExceptionExpected()

This method should be invoked in try-blocks of tests that expect an exception to be thrown.

assertCause

public static <T extends Throwable> T assertCause(Throwable catched,
                                                  Class<T> expectedType)

This method should be invoked in catch-block of tests that catched a given exception and expect that this exception or one of its causes are an instance of the given expectedType.

Type Parameters:

T - is the generic type of the expected cause.

Parameters:

catched - is the Throwable that has been catched.

expectedType - is the Class of the Throwable that is expected.

Returns:

the first Throwable in the hierarchy of catched matching to the given expectedType.

isCause

public static boolean isCause(Throwable catched,
                              Class<? extends Throwable> expectedType)

This method checks if a catched exception or one of its causes is an instance of the given expectedType.

Parameters:

catched - is the Throwable that has been catched.

expectedType - is the Class of the Throwable that is expected.

Returns:

true if the given catched or one of its causes is an instance of the given expectedType.

getCause

public static <T extends Throwable> T getCause(Throwable catched,
                                               Class<T> expectedType)

This method gets a catched exception or one of its causes that is an instance of the given expectedType.

Type Parameters:

T - is the generic type of the expected cause.

Parameters:

catched - is the Throwable that has been catched.

expectedType - is the Class of the Throwable that is expected.

Returns:

true if the given catched or one of its causes is an instance of the given expectedType.

assertCause

public static void assertCause(Throwable catched,
                               Throwable expectedCause)

This method should be invoked in catch-block of tests that catched a given exception and expect that this exception or one of its causes is the same as the given expectedCause.

Parameters:

catched - is the Throwable that has been catched.

expectedCause - is the Throwable that is expected as .

isCause

public static boolean isCause(Throwable catched,
                              Throwable expectedCause)

This method should be invoked in catch-block of tests that catched a given exception and expect that this exception or one of its causes is the same as the given expectedCause.

Parameters:

catched - is the Throwable that has been catched.

expectedCause - is the Throwable that is expected as .

Returns:

true if the given expectedCause is the same as catched or one of its causes.