com.ibm.icu.text
public interface UnicodeMatcher
UnicodeMatcher
defines a protocol for objects that can
match a range of characters in a Replaceable string.UNKNOWN: ICU 2.0
Field Summary | |
---|---|
static char | ETHER
The character at index i, where i < contextStart || i >= contextLimit,
is ETHER. |
static int | U_MATCH
Constant returned by matches() indicating a
complete match between the text and this matcher. |
static int | U_MISMATCH
Constant returned by matches() indicating a
mismatch between the text and this matcher. |
static int | U_PARTIAL_MATCH
Constant returned by matches() indicating a
partial match between the text and this matcher. |
Method Summary | |
---|---|
abstract void | addMatchSetTo(UnicodeSet toUnionTo)
Union the set of all characters that may be matched by this object
into the given set. |
abstract int | matches(Replaceable text, int[] offset, int limit, boolean incremental)
Return a UMatchDegree value indicating the degree of match for
the given text at the given offset. |
abstract boolean | matchesIndexValue(int v)
Returns TRUE if this matcher will match a character c, where c
& 0xFF == v, at offset, in the forward direction (with limit >
offset). |
abstract String | toPattern(boolean escapeUnprintable)
Returns a string representation of this matcher. |
UNKNOWN: ICU 2.0
matches()
indicating a
complete match between the text and this matcher. For an
incremental variable-length match, this value is returned if
the given text matches, and it is known that additional
characters would not alter the extent of the match.UNKNOWN: ICU 2.0
matches()
indicating a
mismatch between the text and this matcher. The text contains
a character which does not match, or the text does not contain
all desired characters for a non-incremental match.UNKNOWN: ICU 2.0
matches()
indicating a
partial match between the text and this matcher. This value is
only returned for incremental match operations. All characters
of the text match, but more characters are required for a
complete match. Alternatively, for variable-length matchers,
all characters of the text match, and if more characters were
supplied at limit, they might also match.UNKNOWN: ICU 2.0
Parameters: toUnionTo the set into which to union the source characters
UNKNOWN: ICU 2.2
Parameters: text the text to be matched offset on input, the index into text at which to begin matching. On output, the limit of the matched text. The number of matched characters is the output value of offset minus the input value. Offset should always point to the HIGH SURROGATE (leading code unit) of a pair of surrogates, both on entry and upon return. limit the limit index of text to be matched. Greater than offset for a forward direction match, less than offset for a backward direction match. The last character to be considered for matching will be text.charAt(limit-1) in the forward direction or text.charAt(limit+1) in the backward direction. incremental if TRUE, then assume further characters may be inserted at limit and check for partial matching. Otherwise assume the text as given is complete.
Returns: a match degree value indicating a full match, a partial match, or a mismatch. If incremental is FALSE then U_PARTIAL_MATCH should never be returned.
UNKNOWN: ICU 2.0
Note: This API uses an int even though the value will be restricted to 8 bits in order to avoid complications with signedness (bytes convert to ints in the range -128..127).
UNKNOWN: ICU 2.0
Parameters: escapeUnprintable if TRUE then convert unprintable character to their hex escape representations, \\uxxxx or \\Uxxxxxxxx. Unprintable characters are those other than U+000A, U+0020..U+007E.
UNKNOWN: ICU 2.0