com.googlecode.catchexception.apis

Class CatchExceptionHamcrestMatchers

java.lang.Object

com.googlecode.catchexception.apis.CatchExceptionHamcrestMatchers

public class CatchExceptionHamcrestMatchers
extends Object

Provides some Hamcrest matchers to match some exception properties.

EXAMPLE:

// given an empty list
List myList = new ArrayList();

// when we try to get the first element of the list
catchException(myList).get(1);

// then we expect an IndexOutOfBoundsException with message "Index: 1, Size: 0" 
assertThat(caughtException(),
  allOf(
    is(IndexOutOfBoundsException.class), 
    hasMessage("Index: 1, Size: 0"),
    hasNoCause()
  )
);

To combine the standard Hamcrest matchers, your custom matchers, these matchers, and other matcher collections (as JUnitMatchers) in a single class follow the instructions outlined in Sugar generation.

Hint: This class might use hamsandwich in the future but as long as hamsandwich is not in any public maven repository, this class will not use hamsandwich.

Author:

rwoo

Constructor Summary

Constructors

Constructor and Description
CatchExceptionHamcrestMatchers()

Method Summary

Methods

Modifier and Type	Method and Description
static <T extends Exception> org.hamcrest.Matcher<T>	hasMessage(String expectedMessage) EXAMPLE: assertThat(caughtException(), hasMessage("Index: 9, Size: 9"));
static <T extends Exception> org.hamcrest.Matcher<T>	hasMessageThat(org.hamcrest.Matcher<String> stringMatcher) EXAMPLES: assertThat(caughtException(), hasMessageThat(is("Index: 9, Size: 9"))); assertThat(caughtException(), hasMessageThat(containsString("Index: 9"))); // using JUnitMatchers assertThat(caughtException(), hasMessageThat(containsPattern("Index: \\d+"))); // using Mockito's Find
static <T extends Exception> org.hamcrest.Matcher<T>	hasNoCause() EXAMPLE: assertThat(caughtException(), hasNoCause());

Methods inherited from class java.lang.Object

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

Constructor Detail

CatchExceptionHamcrestMatchers

public CatchExceptionHamcrestMatchers()

Method Detail

hasMessage

public static <T extends Exception> org.hamcrest.Matcher<T> hasMessage(String expectedMessage)

EXAMPLE:

assertThat(caughtException(), hasMessage("Index: 9, Size: 9"));

Type Parameters:

T - the exception subclass

Parameters:

expectedMessage - the expected exception message

Returns:

Returns a matcher that matches an exception if it has the given message.

hasMessageThat

public static <T extends Exception> org.hamcrest.Matcher<T> hasMessageThat(org.hamcrest.Matcher<String> stringMatcher)

EXAMPLES:

assertThat(caughtException(), hasMessageThat(is("Index: 9, Size: 9")));
assertThat(caughtException(), hasMessageThat(containsString("Index: 9"))); // using JUnitMatchers
assertThat(caughtException(), hasMessageThat(containsPattern("Index: \\d+"))); // using Mockito's Find

Type Parameters:

T - the exception subclass

Parameters:

stringMatcher - a string matcher

Returns:

Returns a matcher that matches an exception if the given string matcher matches the exception message.

hasNoCause

public static <T extends Exception> org.hamcrest.Matcher<T> hasNoCause()

EXAMPLE:

assertThat(caughtException(), hasNoCause());

Type Parameters:

T - the exception subclass

Returns:

Returns a matcher that matches the exception if it does not have a cause.