net.obvj.junit.utils.matchers

Class StringMatcher

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.hamcrest.TypeSafeDiagnosingMatcher<String>

net.obvj.junit.utils.matchers.StringMatcher

All Implemented Interfaces:

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

public class StringMatcher
extends org.hamcrest.TypeSafeDiagnosingMatcher<String>

A Matcher that evaluates the content of a string of characters against one or more substrings.

Since:

1.1.0

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
static StringMatcher	containsAll(String... substrings) Creates a matcher that matches if the examined string contains all of the specified substrings (regardless of the order they appear in the string).
static StringMatcher	containsAny(String... substrings) Creates a matcher that matches if the examined string contains any of the specified substrings.
static StringMatcher	containsNone(String... substrings) Creates a matcher that matches if the examined string contains none of the specified substrings.
void	describeTo(org.hamcrest.Description description) Describes the "expected" pat of the test description.
StringMatcher	ignoreCase() Tells the matcher to compare strings irrespective of case.

Methods inherited from class org.hamcrest.TypeSafeDiagnosingMatcher

describeMismatch, matches

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

containsAll

public static StringMatcher containsAll(String... substrings)

Creates a matcher that matches if the examined string contains all of the specified substrings (regardless of the order they appear in the string).

For example:

 assertThat("the quick brown fox", containsAll("fox", "the"))
 

Parameters:

substrings - the substrings to be tested

Returns:

the matcher

containsAny

public static StringMatcher containsAny(String... substrings)

Creates a matcher that matches if the examined string contains any of the specified substrings.

For example:

 assertThat("the quick brown fox", containsAny("fox", "dragon"))
 

Parameters:

substrings - the substrings to be tested

Returns:

the matcher

containsNone

public static StringMatcher containsNone(String... substrings)

Creates a matcher that matches if the examined string contains none of the specified substrings.

For example:

 assertThat("the quick brown fox", containsNone("cat", "mouse"))
 

Parameters:

substrings - the substrings to be tested

Returns:

the matcher

ignoreCase

public StringMatcher ignoreCase()

Tells the matcher to compare strings irrespective of case.

For example:

 assertThat("the quick brown fox", containsAny("FOX").ignoreCase())
 

Returns:

the matcher

describeTo

public void describeTo(org.hamcrest.Description description)

Describes the "expected" pat of the test description.

Parameters:

description - the Description to be appended to