Package org.hamcrest.core

Class StringRegularExpression

java.lang.Object

org.hamcrest.BaseMatcher<String>

org.hamcrest.TypeSafeDiagnosingMatcher<String>

org.hamcrest.core.StringRegularExpression

All Implemented Interfaces:

Matcher<String>, SelfDescribing

public class StringRegularExpression
extends TypeSafeDiagnosingMatcher<String>

A matcher that checks a string against a regular expression.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StringRegularExpression(Pattern pattern)	Constructor, best used from matchesRegex(String).

Method Summary

Modifier and Type	Method	Description
void	describeTo(Description description)	Generates a description of the object.
static Matcher<String>	matchesRegex(String regex)	Creates a matcher that checks if the examined string matches a specified regex.
static Matcher<String>	matchesRegex(Pattern pattern)	Creates a matcher that checks if the examined string matches a specified Pattern.
protected boolean	matchesSafely(String actual, Description mismatchDescription)	Subclasses should implement this.

Methods inherited from class org.hamcrest.TypeSafeDiagnosingMatcher

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

StringRegularExpression

protected StringRegularExpression(Pattern pattern)

Constructor, best used from matchesRegex(String).

Parameters:

pattern - the regular expression to match against

Method Details

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.

matchesSafely

protected boolean matchesSafely(String actual,
 Description mismatchDescription)

Description copied from class: TypeSafeDiagnosingMatcher

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 TypeSafeDiagnosingMatcher<String>

Parameters:

actual - the item.

mismatchDescription - the mismatch description.

Returns:

boolean true/false depending if item matches matcher.

matchesRegex

public static Matcher<String> matchesRegex(Pattern pattern)

Creates a matcher that checks if the examined string matches a specified Pattern.

 assertThat("abc", matchesRegex(Pattern.compile("ˆ[a-z]$"));
 

Parameters:

pattern - the pattern to be used.

Returns:

The matcher.

matchesRegex

public static Matcher<String> matchesRegex(String regex)

Creates a matcher that checks if the examined string matches a specified regex.

 assertThat("abc", matchesRegex("ˆ[a-z]+$"));
 

Parameters:

regex - The regex to be used for the validation.

Returns:

The matcher.