Package org.hamcrest.core

Class StringContains

java.lang.Object

org.hamcrest.BaseMatcher<String>

org.hamcrest.TypeSafeMatcher<String>

org.hamcrest.core.SubstringMatcher

org.hamcrest.core.StringContains

All Implemented Interfaces:

Matcher<String>, SelfDescribing

public class StringContains
extends SubstringMatcher

Tests if the argument is a string that contains a specific substring.

Field Summary

Fields inherited from class org.hamcrest.core.SubstringMatcher

substring

Constructor Summary

Constructors

Constructor	Description
StringContains(boolean ignoringCase, String substring)	Constructor, best used with containsString(String) or containsStringIgnoringCase(String).
StringContains(String substring)	Constructor, best used with containsString(String).

Method Summary

Modifier and Type	Method	Description
static Matcher<String>	containsString(String substring)	Creates a matcher that matches if the examined String contains the specified String anywhere.
static Matcher<String>	containsStringIgnoringCase(String substring)	Creates a matcher that matches if the examined String contains the specified String anywhere, ignoring case.
protected boolean	evalSubstringOf(String s)	Checks if the input matches the specific substring.

Methods inherited from class org.hamcrest.core.SubstringMatcher

converted, describeMismatchSafely, describeTo, matchesSafely

Methods inherited from class org.hamcrest.TypeSafeMatcher

describeMismatch, matches

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, isNotNull, toString

Methods inherited from class java.lang.Object

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

Constructor Details

StringContains

public StringContains(String substring)

Constructor, best used with containsString(String).

Parameters:

substring - the expected substring.

StringContains

public StringContains(boolean ignoringCase,
 String substring)

Constructor, best used with containsString(String) or containsStringIgnoringCase(String).

Parameters:

ignoringCase - whether to ignore case when matching

substring - the expected substring.

Method Details

evalSubstringOf

protected boolean evalSubstringOf(String s)

Description copied from class: SubstringMatcher

Checks if the input matches the specific substring.

Specified by:

evalSubstringOf in class SubstringMatcher

Parameters:

s - the string to check

Returns:

the result of the match

containsString

public static Matcher<String> containsString(String substring)

Creates a matcher that matches if the examined String contains the specified String anywhere. For example:

assertThat("myStringOfNote", containsString("ring"))

Parameters:

substring - the substring that the returned matcher will expect to find within any examined string

Returns:

The matcher.

containsStringIgnoringCase

public static Matcher<String> containsStringIgnoringCase(String substring)

Creates a matcher that matches if the examined String contains the specified String anywhere, ignoring case. For example:

assertThat("myStringOfNote", containsStringIgnoringCase("Ring"))

Parameters:

substring - the substring that the returned matcher will expect to find within any examined string

Returns:

The matcher.