de.weltraumschaf.commons.testing.hamcrest

Class HasMessage

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.hamcrest.TypeSafeMatcher<Throwable>

de.weltraumschaf.commons.testing.hamcrest.HasMessage

All Implemented Interfaces:

Matcher<Throwable>, SelfDescribing

final class HasMessage
extends TypeSafeMatcher<Throwable>

Does have a Throwable a message, which matches something.

Example:

 
  public class MyTest {

      private final SomeClass sut = new SomeClass();

      @Test
      public void throwsFooException() {
          final Throwable result = sut.makeError("foobar");

          assertThat(result, hasMessage(is("foobar")));
      }
  }
 

Since:

1.0.0

Author:

Sven Strittmatter <weltraumschaf@googlemail.com>

Field Summary

Fields

Modifier and Type	Field and Description
private Matcher<? super String>	messageTextMatcher String matcher for expected message.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	HasMessage(Matcher<? super String> messageTextMatcher) Dedicated constructor.

Method Summary

Modifier and Type	Method and Description
void	describeTo(Description description)
static Matcher<Throwable>	hasMessage(Matcher<? super String> messageTextMatcher) Creates a matcher of Throwables that matches when its message matched be messageTextMatcher.
protected boolean	matchesSafely(Throwable item)

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

Field Detail

messageTextMatcher

private final Matcher<? super String> messageTextMatcher

String matcher for expected message.

Constructor Detail

HasMessage

private HasMessage(Matcher<? super String> messageTextMatcher)

Dedicated constructor.

Use hasMessage(org.hamcrest.Matcher) to create new instances.

Parameters:

messageTextMatcher - must not be null

Method Detail

describeTo

public void describeTo(Description description)

matchesSafely

protected boolean matchesSafely(Throwable item)

Specified by:

matchesSafely in class TypeSafeMatcher<Throwable>

hasMessage

public static Matcher<Throwable> hasMessage(Matcher<? super String> messageTextMatcher)

Creates a matcher of Throwables that matches when its message matched be messageTextMatcher.

For example:

 
 assertThat(exception, hasMessage(equalTo("Parameter is required.")))
 

Parameters:

messageTextMatcher - matcher for actual message., not null.

Returns:

never null