com.github.marschall.junitlambda

Class ThrowsException<T extends Throwable>

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.hamcrest.TypeSafeMatcher<Block>

com.github.marschall.junitlambda.ThrowsException<T>

Type Parameters:

T - the expected throwable type

All Implemented Interfaces:

org.hamcrest.Matcher<Block>, org.hamcrest.SelfDescribing

public final class ThrowsException<T extends Throwable>
extends org.hamcrest.TypeSafeMatcher<Block>

Tests if the argument block throws an exception.

See Also:

HasCause, HasMessage, Block

Method Summary

Modifier and Type	Method and Description
void	describeTo(org.hamcrest.Description description)
protected boolean	matchesSafely(Block block)
static <T extends Throwable> org.hamcrest.Matcher<Block>	throwsException(Class<T> expectedExceptionClass) Creates a matcher that matches if the examined Block throws an exception of the specified expectedExceptionClass.
static <T extends Throwable> org.hamcrest.TypeSafeMatcher<Block>	throwsException(Class<T> expectedExceptionClass, org.hamcrest.Matcher<T> exceptionMatcher) Creates a matcher that matches if the examined Block throws an exception of the specified expectedExceptionClass and is matched by the specified exceptionMatcher.
static <T extends Throwable> org.hamcrest.TypeSafeMatcher<Block>	throwsException(Class<T> expectedExceptionClass, org.hamcrest.Matcher<T> exceptionMatcher, org.hamcrest.Matcher<T>... additionalExceptionMatchers) Creates a matcher that matches if the examined Block throws an exception of the specified expectedExceptionClass and is matched by the specified exceptionMatcher and additionalExceptionMatchers.

Methods inherited from class org.hamcrest.TypeSafeMatcher

describeMismatch, describeMismatchSafely, matches

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, toString

Methods inherited from class java.lang.Object

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

Method Detail

throwsException

public static <T extends Throwable> org.hamcrest.Matcher<Block> throwsException(Class<T> expectedExceptionClass)

Creates a matcher that matches if the examined Block throws an exception of the specified expectedExceptionClass.

For example:

assertThat(() -> Long.parseLong("foo"), throwsException(NumberFormatException.class));

Type Parameters:

T - the expected throwable type

Parameters:

expectedExceptionClass - the expected exception type

Returns:

the matcher

throwsException

public static <T extends Throwable> org.hamcrest.TypeSafeMatcher<Block> throwsException(Class<T> expectedExceptionClass,
                                                                                        org.hamcrest.Matcher<T> exceptionMatcher)

Creates a matcher that matches if the examined Block throws an exception of the specified expectedExceptionClass and is matched by the specified exceptionMatcher.

For example:

assertThat(() -> Long.parseLong("foo"), throwsException(NumberFormatException.class, hasMessage("For input string: \"foo\"")));

Type Parameters:

T - the expected throwable type

Parameters:

expectedExceptionClass - the expected exception type

exceptionMatcher - the matcher to apply to the examined exception

Returns:

the matcher

throwsException

@SafeVarargs
public static <T extends Throwable> org.hamcrest.TypeSafeMatcher<Block> throwsException(Class<T> expectedExceptionClass,
                                                                                                     org.hamcrest.Matcher<T> exceptionMatcher,
                                                                                                     org.hamcrest.Matcher<T>... additionalExceptionMatchers)

Creates a matcher that matches if the examined Block throws an exception of the specified expectedExceptionClass and is matched by the specified exceptionMatcher and additionalExceptionMatchers.

For example:

assertThat(() -> Long.parseLong("foo"), throwsException(NumberFormatException.class, hasMessage("For input string: \"foo\""), hasCause(nullValue())));

Type Parameters:

T - the expected throwable type

Parameters:

expectedExceptionClass - the expected exception type

exceptionMatcher - the matcher to apply to the examined exception

additionalExceptionMatchers - additional matchers to apply to the examined exception

Returns:

the matcher

describeTo

public void describeTo(org.hamcrest.Description description)

matchesSafely

protected boolean matchesSafely(Block block)

Specified by:

matchesSafely in class org.hamcrest.TypeSafeMatcher<Block>