Class StrMatcher
This class comes complete with various factory methods. If these do not suffice, you can subclass and implement your own matcher.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic StrMatcher
charMatcher
(char ch) Constructor that creates a matcher from a character.static StrMatcher
charSetMatcher
(char[] chars) Constructor that creates a matcher from a set of characters.static StrMatcher
charSetMatcher
(String chars) Constructor that creates a matcher from a string representing a set of characters.static StrMatcher
Returns a matcher which matches the comma character.static StrMatcher
Returns a matcher which matches the double quote character.int
isMatch
(char[] buffer, int pos) Returns the number of matching characters, zero for no match.abstract int
isMatch
(char[] buffer, int pos, int bufferStart, int bufferEnd) Returns the number of matching characters, zero for no match.static StrMatcher
Matches no characters.static StrMatcher
Returns a matcher which matches the single or double quote character.static StrMatcher
Returns a matcher which matches the single quote character.static StrMatcher
Returns a matcher which matches the space character.static StrMatcher
Matches the same characters as StringTokenizer, namely space, tab, newline and formfeed.static StrMatcher
stringMatcher
(String str) Constructor that creates a matcher from a string.static StrMatcher
Returns a matcher which matches the tab character.static StrMatcher
Matches the String trim() whitespace characters.
-
Constructor Details
-
StrMatcher
protected StrMatcher()Constructor.
-
-
Method Details
-
commaMatcher
Returns a matcher which matches the comma character.- Returns:
- a matcher for a comma
-
tabMatcher
Returns a matcher which matches the tab character.- Returns:
- a matcher for a tab
-
spaceMatcher
Returns a matcher which matches the space character.- Returns:
- a matcher for a space
-
splitMatcher
Matches the same characters as StringTokenizer, namely space, tab, newline and formfeed.- Returns:
- the split matcher
-
trimMatcher
Matches the String trim() whitespace characters.- Returns:
- the trim matcher
-
singleQuoteMatcher
Returns a matcher which matches the single quote character.- Returns:
- a matcher for a single quote
-
doubleQuoteMatcher
Returns a matcher which matches the double quote character.- Returns:
- a matcher for a double quote
-
quoteMatcher
Returns a matcher which matches the single or double quote character.- Returns:
- a matcher for a single or double quote
-
noneMatcher
Matches no characters.- Returns:
- a matcher that matches nothing
-
charMatcher
Constructor that creates a matcher from a character.- Parameters:
ch
- the character to match, must not be null- Returns:
- a new Matcher for the given char
-
charSetMatcher
Constructor that creates a matcher from a set of characters.- Parameters:
chars
- the characters to match, null or empty matches nothing- Returns:
- a new matcher for the given char[]
-
charSetMatcher
Constructor that creates a matcher from a string representing a set of characters.- Parameters:
chars
- the characters to match, null or empty matches nothing- Returns:
- a new Matcher for the given characters
-
stringMatcher
Constructor that creates a matcher from a string.- Parameters:
str
- the string to match, null or empty matches nothing- Returns:
- a new Matcher for the given String
-
isMatch
public abstract int isMatch(char[] buffer, int pos, int bufferStart, int bufferEnd) Returns the number of matching characters, zero for no match.This method is called to check for a match. The parameter
pos
represents the current position to be checked in the stringbuffer
(a character array which must not be changed). The API guarantees thatpos
is a valid index forbuffer
.The character array may be larger than the active area to be matched. Only values in the buffer between the specified indices may be accessed.
The matching code may check one character or many. It may check characters preceding
pos
as well as those after, so long as no checks exceed the bounds specified.It must return zero for no match, or a positive number if a match was found. The number indicates the number of characters that matched.
- Parameters:
buffer
- the text content to match against, do not changepos
- the starting position for the match, valid for bufferbufferStart
- the first active index in the buffer, valid for bufferbufferEnd
- the end index (exclusive) of the active buffer, valid for buffer- Returns:
- the number of matching characters, zero for no match
-
isMatch
public int isMatch(char[] buffer, int pos) Returns the number of matching characters, zero for no match.This method is called to check for a match. The parameter
pos
represents the current position to be checked in the stringbuffer
(a character array which must not be changed). The API guarantees thatpos
is a valid index forbuffer
.The matching code may check one character or many. It may check characters preceding
pos
as well as those after.It must return zero for no match, or a positive number if a match was found. The number indicates the number of characters that matched.
- Parameters:
buffer
- the text content to match against, do not changepos
- the starting position for the match, valid for buffer- Returns:
- the number of matching characters, zero for no match
- Since:
- 2.4
-