Package org.hamcrest.text

Class MatchesPattern

java.lang.Object

org.hamcrest.BaseMatcher<String>

org.hamcrest.TypeSafeMatcher<String>

org.hamcrest.text.MatchesPattern

All Implemented Interfaces:

Matcher<String>, SelfDescribing

public class MatchesPattern
extends TypeSafeMatcher<String>

Tests if a string matches a regular expression.

Constructor Summary

Constructors

Constructor	Description
MatchesPattern(Pattern pattern)	Constructor, best called from matchesPattern(String) or matchesPattern(Pattern).

Method Summary

Modifier and Type	Method	Description
void	describeTo(Description description)	Generates a description of the object.
static Matcher<String>	matchesPattern(String regex)	Creates a matcher of String that matches when the examined string exactly matches the given regular expression, treated as a Pattern.
static Matcher<String>	matchesPattern(Pattern pattern)	Creates a matcher of String that matches when the examined string exactly matches the given Pattern.
protected boolean	matchesSafely(String item)	Check if the item matches.

Methods inherited from class org.hamcrest.TypeSafeMatcher

describeMismatch, describeMismatchSafely, 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

MatchesPattern

public MatchesPattern(Pattern pattern)

Constructor, best called from matchesPattern(String) or matchesPattern(Pattern).

Parameters:

pattern - the regular expression to match

Method Details

matchesSafely

protected boolean matchesSafely(String item)

Description copied from class: TypeSafeMatcher

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

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.

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.

matchesPattern

public static Matcher<String> matchesPattern(Pattern pattern)

Creates a matcher of String that matches when the examined string exactly matches the given Pattern.

Parameters:

pattern - the text pattern to match.

Returns:

The matcher.

matchesPattern

public static Matcher<String> matchesPattern(String regex)

Creates a matcher of String that matches when the examined string exactly matches the given regular expression, treated as a Pattern.

Parameters:

regex - the regex to match.

Returns:

The matcher.