public interface StringMatcher
Modifier and Type | Method and Description |
---|---|
default StringMatcher |
andThen(StringMatcher stringMatcher)
Returns a matcher that matches this matcher followed by the given matcher.
|
default int |
isMatch(char[] buffer,
int pos)
Returns the number of matching characters, zero for no match.
|
int |
isMatch(char[] buffer,
int start,
int bufferStart,
int bufferEnd)
Returns the number of matching characters,
0 if there is no match. |
default int |
isMatch(CharSequence buffer,
int pos)
Returns the number of matching characters, zero for no match.
|
default int |
isMatch(CharSequence buffer,
int start,
int bufferStart,
int bufferEnd)
Returns the number of matching characters,
0 if there is no match. |
default int |
size()
Returns the size of the matching string.
|
default StringMatcher andThen(StringMatcher stringMatcher)
stringMatcher
- the next matcher.default 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 bufferint isMatch(char[] buffer, int start, int bufferStart, int bufferEnd)
0
if there is no match.
This method is called to check for a match against a source buffer
. The parameter start
represents the start position to be checked in the buffer
(a character array which MUST not be changed).
The implementation SHOULD guarantees that start
is a valid index in 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, in other words: bufferStart <= start < bufferEnd
.
The matching code may check one character or many. It may check characters preceding start
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 source text to search, do not change.start
- the starting position for the match, valid in buffer
.bufferStart
- the first active index in the buffer, valid in buffer
.bufferEnd
- the end index (exclusive) of the active buffer, valid in buffer
.default int isMatch(CharSequence 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 bufferdefault int isMatch(CharSequence buffer, int start, int bufferStart, int bufferEnd)
0
if there is no match.
This method is called to check for a match against a source buffer
. The parameter start
represents the start position to be checked in the buffer
(a character array which MUST not be changed).
The implementation SHOULD guarantees that start
is a valid index in 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, in other words: bufferStart <= start < bufferEnd
.
The matching code may check one character or many. It may check characters preceding start
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 source text to search, do not change.start
- the starting position for the match, valid in buffer
.bufferStart
- the first active index in the buffer, valid in buffer
.bufferEnd
- the end index (exclusive) of the active buffer, valid in buffer
.default int size()
Copyright © 2014–2022 The Apache Software Foundation. All rights reserved.