com.oracle.bedrock.matchers

Class ThrowableMatcher<T>

java.lang.Object

org.hamcrest.BaseMatcher<T>

com.oracle.bedrock.matchers.ThrowableMatcher<T>

All Implemented Interfaces:

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

public class ThrowableMatcher<T>
extends org.hamcrest.BaseMatcher<T>

A Matcher that can be used to match Throwables raised while performing assertions instead of matching values.

Typically this class is used with the assertion methods provided by the Eventually class.

For example: Eventually.assertThat(invoking(object).someMethod(), willThrow(instanceOf(NullPointerException.class)));

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Brian Oliver

Method Summary

Modifier and Type	Method and Description
ThrowableMatcher<T>	causedBy(org.hamcrest.Matcher<? super Throwable> matcher) Obtains a new ThrowableMatcher that includes matching a cause of the Throwable.
void	describeTo(org.hamcrest.Description description)
org.hamcrest.Matcher<? super Throwable>	getMatcher() Obtain the Matcher for the Throwable.
boolean	matches(Object o)
static <T> ThrowableMatcher<T>	willThrow(Class<? extends Throwable> throwableClass) Obtains a ThrowableMatcher for the specified class of Throwable.
static <T> ThrowableMatcher<T>	willThrow(org.hamcrest.Matcher<? super Throwable> matcher) Obtains a ThrowableMatcher for a Matcher of Throwables.
ThrowableMatcher<T>	withMessage(org.hamcrest.Matcher<? super String> matcher) Obtains a new ThrowableMatcher that includes the matching the Throwable.getMessage()
ThrowableMatcher<T>	withMessage(String message) Obtains a new ThrowableMatcher that includes matching the specified message.

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, describeMismatch, toString

Methods inherited from class java.lang.Object

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

Method Detail

willThrow

public static <T> ThrowableMatcher<T> willThrow(Class<? extends Throwable> throwableClass)

Obtains a ThrowableMatcher for the specified class of Throwable.

Type Parameters:

T - an expected type of value

Parameters:

throwableClass - the class of Throwable

Returns:

a ThrowableMatcher

willThrow

public static <T> ThrowableMatcher<T> willThrow(org.hamcrest.Matcher<? super Throwable> matcher)

Obtains a ThrowableMatcher for a Matcher of Throwables.

Type Parameters:

T - an expected type of value

Parameters:

matcher - the Matcher for Throwables

Returns:

a ThrowableMatcher

withMessage

public ThrowableMatcher<T> withMessage(org.hamcrest.Matcher<? super String> matcher)

Obtains a new ThrowableMatcher that includes the matching the Throwable.getMessage()

Parameters:

matcher - the Matcher

Returns:

a new ThrowableMatcher

withMessage

public ThrowableMatcher<T> withMessage(String message)

Obtains a new ThrowableMatcher that includes matching the specified message.

Parameters:

message - the message to match

Returns:

a new ThrowableMatcher

causedBy

public ThrowableMatcher<T> causedBy(org.hamcrest.Matcher<? super Throwable> matcher)

Obtains a new ThrowableMatcher that includes matching a cause of the Throwable.

Parameters:

matcher - the matched for the caused-by Throwable

Returns:

a new ThrowableMatcher

getMatcher

public org.hamcrest.Matcher<? super Throwable> getMatcher()

Obtain the Matcher for the Throwable.

Returns:

the Throwable Matcher

matches

public boolean matches(Object o)

describeTo

public void describeTo(org.hamcrest.Description description)