net.sf.expectit.matcher

Class Matchers

java.lang.Object

net.sf.expectit.matcher.Matchers

public final class Matchers
extends Object

The matcher factory.

Author:

Alexey Gavrilov

Method Summary

Modifier and Type	Method and Description
static Matcher<MultiResult>	allOf(Matcher<?>... matchers) Creates a matcher that matches if the examined input matches all of the specified matchers.
static Matcher<MultiResult>	anyOf(Matcher<?>... matchers) Creates a matcher that matches if the examined input matches any of the specified matchers.
static Matcher<Result>	anyString() Creates a matcher that matches when at least one character exists in the input buffer.
static Matcher<Result>	contains(String string) Creates a matcher of String that matches when examined input contains the given substring.
static Matcher<Result>	eof() Creates a matcher that matches if input reaches the end of stream.
static Matcher<Result>	exact(String exact) Creates a matcher that matches when the given string is equal to the input buffer contents.
static Matcher<Result>	matches(Pattern pattern) Creates a matcher of Pattern that matches when examined input fully matches the given regular expression.
static Matcher<Result>	matches(String pattern) Creates a matcher of String that matches when examined input fully matches the given regular expression.
static Matcher<Result>	regexp(Pattern pattern) Creates a matcher of Pattern that matches when examined input contains the given regular expression.
static Matcher<Result>	regexp(String pattern) Creates a matcher of String that matches when examined input contains the given regular expression.
static Matcher<MultiResult>	sequence(Matcher<?>... matchers) Matches the given matchers one by one.
static Matcher<Result>	startsWith(String prefix) Creates a matcher that matches when the input buffer starts with the given string.
static Matcher<MultiResult>	times(int number, Matcher<?> matcher) Creates a matcher that matches if the given matcher matches the number of times.

Methods inherited from class java.lang.Object

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

Method Detail

matches

public static Matcher<Result> matches(String pattern)

Creates a matcher of String that matches when examined input fully matches the given regular expression.

This method simply compiles the given pattern to a Pattern and passes it to the matches(java.util.regex.Pattern) method.

Parameters:

pattern - the pattern that represents regular expression

Returns:

the match result

See Also:

regexp(java.util.regex.Pattern)

matches

public static Matcher<Result> matches(Pattern pattern)

Creates a matcher of Pattern that matches when examined input fully matches the given regular expression. The operation is equivalent to the Matcher.matches() method.

The returning Result implements the MatchResult methods to query the results of the regular expression match.

If the match succeeded, the input buffer is cleared and .Result#getBefore() returns an empty string.

Parameters:

pattern - the representation of a regular expression

Returns:

the match result

regexp

public static Matcher<Result> regexp(String pattern)

Creates a matcher of String that matches when examined input contains the given regular expression.

This method simply compiles the given string to a Pattern and passes it to the regexp(java.util.regex.Pattern) method.

Parameters:

pattern - the string that represents regular expression

Returns:

the match result

See Also:

regexp(java.util.regex.Pattern)

regexp

public static Matcher<Result> regexp(Pattern pattern)

Creates a matcher of Pattern that matches when examined input contains the given regular expression. The operation is equivalent to the Matcher.find() method.

The returning Result implements the MatchResult methods to query the results of the regular expression match.

If the match succeeded, the input buffer is updated: the input part from the beginning until the end position of the match is removed.

Parameters:

pattern - the representation of a regular expression

Returns:

the match result

contains

public static Matcher<Result> contains(String string)

Creates a matcher of String that matches when examined input contains the given substring.

The returning Result has no groups except the one with 0 index which represents the exact string match.

If the match succeeded, the input buffer is updated: the input part from the beginning until the end position of the match is removed.

Parameters:

string - the string to search for

Returns:

the match result

allOf

public static Matcher<MultiResult> allOf(Matcher<?>... matchers)

Creates a matcher that matches if the examined input matches all of the specified matchers. This method evaluates all the matchers regardless intermediate results.

The match result represents a combination of all match operations. If succeeded, the match result with the greatest end position is selected to implement the result Result instance returned by this method. If the result is negative, then the one which fails first is returned.

If several matchers the have same end position, then the result from the one with the smaller argument index is returned.

Parameters:

matchers - the vararg array of the matchers

Returns:

the multi match result

anyOf

public static Matcher<MultiResult> anyOf(Matcher<?>... matchers)

Creates a matcher that matches if the examined input matches any of the specified matchers.

The match result represents a combination of any match operations. If succeeded, the match result with the greatest end position is selected to implement the result Result instance returned by this method.

If several matchers have the same end position, then the result from the one with the smaller argument index is returned.

Parameters:

matchers - the vararg array of the matchers

Returns:

the multi match result

eof

public static Matcher<Result> eof()

Creates a matcher that matches if input reaches the end of stream.

If succeeded, the Result.getBefore() will return the entire input buffer, and the MatchResult.group() returns an empty string.

Returns:

the matcher

times

public static Matcher<MultiResult> times(int number,
                                         Matcher<?> matcher)

Creates a matcher that matches if the given matcher matches the number of times.

The match result represents a combination of all the performed match operations. If succeeded, the result with the greatest end position is returned.

Parameters:

number - the number of times which the given matcher must match the input

matcher - the matcher

Returns:

the result

sequence

public static Matcher<MultiResult> sequence(Matcher<?>... matchers)

Matches the given matchers one by one. Every successful matches updates the internal buffer. The consequent match operation is performed after the previous match has succeeded.

Parameters:

matchers - the collection of matchers.

Returns:

the matcher.

anyString

public static Matcher<Result> anyString()

Creates a matcher that matches when at least one character exists in the input buffer.

If the result is successful, the Result.getBefore() returns an empty string, the MatchResult.group() returns the entire input buffer.

Returns:

the result

exact

public static Matcher<Result> exact(String exact)

Creates a matcher that matches when the given string is equal to the input buffer contents.

If the result is successful, the Result.getBefore() returns an empty string, the MatchResult.group() returns the entire input buffer.

Parameters:

exact - the string to match.

Returns:

the result.

startsWith

public static Matcher<Result> startsWith(String prefix)

Creates a matcher that matches when the input buffer starts with the given string.

If the result is successful, the Result.getBefore() returns an empty string, the MatchResult.group() returns the given string.

Parameters:

prefix - the prefix string to match.

Returns:

the result.