public abstract class StrMatcher extends Object
This class comes complete with various factory methods. If these do not suffice, you can subclass and implement your own matcher.
Modifier | Constructor and Description |
---|---|
protected |
StrMatcher()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static 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 |
commaMatcher()
Returns a matcher which matches the comma character.
|
static StrMatcher |
doubleQuoteMatcher()
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 |
noneMatcher()
Matches no characters.
|
static StrMatcher |
quoteMatcher()
Returns a matcher which matches the single or double quote character.
|
static StrMatcher |
singleQuoteMatcher()
Returns a matcher which matches the single quote character.
|
static StrMatcher |
spaceMatcher()
Returns a matcher which matches the space character.
|
static StrMatcher |
splitMatcher()
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 |
tabMatcher()
Returns a matcher which matches the tab character.
|
static StrMatcher |
trimMatcher()
Matches the String trim() whitespace characters.
|
protected StrMatcher()
public static StrMatcher commaMatcher()
public static StrMatcher tabMatcher()
public static StrMatcher spaceMatcher()
public static StrMatcher splitMatcher()
public static StrMatcher trimMatcher()
public static StrMatcher singleQuoteMatcher()
public static StrMatcher doubleQuoteMatcher()
public static StrMatcher quoteMatcher()
public static StrMatcher noneMatcher()
public static StrMatcher charMatcher(char ch)
ch
- the character to match, must not be nullpublic static StrMatcher charSetMatcher(char[] chars)
chars
- the characters to match, null or empty matches nothingpublic static StrMatcher charSetMatcher(String chars)
chars
- the characters to match, null or empty matches nothingpublic static StrMatcher stringMatcher(String str)
str
- the string to match, null or empty matches nothingpublic abstract int isMatch(char[] buffer, int pos, int bufferStart, int bufferEnd)
This method is called to check for a match.
The parameter pos
represents the current position to be
checked in the string buffer
(a character array which must
not be changed).
The API guarantees that pos
is a valid index for buffer
.
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.
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 bufferpublic int isMatch(char[] buffer, int pos)
This method is called to check for a match.
The parameter pos
represents the current position to be
checked in the string buffer
(a character array which must
not be changed).
The API guarantees that pos
is a valid index for buffer
.
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.
buffer
- the text content to match against, do not changepos
- the starting position for the match, valid for bufferCopyright © 1999-2021 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.