Package org.hamcrest.core

Class SubstringMatcher

java.lang.Object

org.hamcrest.BaseMatcher<String>

org.hamcrest.TypeSafeMatcher<String>

org.hamcrest.core.SubstringMatcher

All Implemented Interfaces:

Matcher<String>, SelfDescribing

Direct Known Subclasses:

StringContains, StringEndsWith, StringStartsWith

public abstract class SubstringMatcher
extends TypeSafeMatcher<String>

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	substring

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SubstringMatcher(String relationship, boolean ignoringCase, String substring)

Method Summary

Modifier and Type	Method	Description
protected String	converted(String arg)
void	describeMismatchSafely(String item, Description mismatchDescription)	Subclasses should override this.
void	describeTo(Description description)	Generates a description of the object.
protected abstract boolean	evalSubstringOf(String string)
boolean	matchesSafely(String item)	Subclasses should implement this.

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

Field Details

substring

protected final String substring

Constructor Details

SubstringMatcher

protected SubstringMatcher(String relationship,
 boolean ignoringCase,
 String substring)

Method Details

matchesSafely

public boolean matchesSafely(String item)

Description copied from class: TypeSafeMatcher

Subclasses should implement this. The item will already have been checked for the specific type and will never be null.

Specified by:

matchesSafely in class TypeSafeMatcher<String>

Parameters:

item - the type safe item to match against.

Returns:

boolean true/false depending if item matches matcher.

describeMismatchSafely

public void describeMismatchSafely(String item,
 Description mismatchDescription)

Description copied from class: TypeSafeMatcher

Subclasses should override this. The item will already have been checked for the specific type and will never be null.

Overrides:

describeMismatchSafely in class TypeSafeMatcher<String>

Parameters:

item - the type safe item to match against.

mismatchDescription - the mismatch description.

describeTo

public void describeTo(Description description)

Description copied from interface: SelfDescribing

Generates a description of the object. The description may be part of a description of a larger object of which this is just a component, so it should be worded appropriately.

Parameters:

description - The description to be built or appended to.

converted

protected String converted(String arg)

evalSubstringOf

protected abstract boolean evalSubstringOf(String string)