org.whaka.asserts.matcher

Class ThrowableMatcher

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.whaka.asserts.matcher.ResultProvidingMatcher<java.lang.Throwable>

org.whaka.asserts.matcher.ThrowableMatcher

All Implemented Interfaces:

org.hamcrest.Matcher<java.lang.Throwable>, org.hamcrest.SelfDescribing

public class ThrowableMatcher
extends ResultProvidingMatcher<java.lang.Throwable>

Class implements a Matcher that checks type of an exception. If specified expected type is null then matcher will expect null instead of actual throwable value.

Difference from Matchers.instanceOf(Class) and Matchers.nullValue() is that this matcher sets asserted throwable as cause of the result.

Also matcher produces more obvious (exception related) messages.

See Also:

throwableOfType(Class), notExpected()

Method Summary

Modifier and Type	Method and Description
void	describeTo(org.hamcrest.Description description)
java.lang.Class<? extends java.lang.Throwable>	getExpectedType()
java.util.Optional<AssertResult>	matches(java.lang.Throwable item, java.lang.String message, java.lang.Throwable cause) This method should return Optional.empty() in case matcher successfully matched specified item.
static ThrowableMatcher	notExpected() Creates an instance of ThrowableMatcher with null as expected type.
static ThrowableMatcher	throwableOfType(java.lang.Class<? extends java.lang.Throwable> type) Creates an instance of ThrowableMatcher with specified type, as expected.

Methods inherited from class org.whaka.asserts.matcher.ResultProvidingMatcher

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

getExpectedType

public java.lang.Class<? extends java.lang.Throwable> getExpectedType()

matches

public java.util.Optional<AssertResult> matches(java.lang.Throwable item,
                                                java.lang.String message,
                                                java.lang.Throwable cause)

Description copied from class: ResultProvidingMatcher

This method should return Optional.empty() in case matcher successfully matched specified item. Otherwise it should return an optional containing an instance of the AssertResult.

Specified by:

matches in class ResultProvidingMatcher<java.lang.Throwable>

describeTo

public void describeTo(org.hamcrest.Description description)

throwableOfType

public static ThrowableMatcher throwableOfType(java.lang.Class<? extends java.lang.Throwable> type)

Creates an instance of ThrowableMatcher with specified type, as expected.

See Also:

notExpected()

notExpected

public static ThrowableMatcher notExpected()

Creates an instance of ThrowableMatcher with null as expected type.

See Also:

throwableOfType(Class)