UnicodeMatcher

ETHER

public static final char ETHER

The character at index i, where i < contextStart || i >= contextLimit, is ETHER. This allows explicit matching by rules and UnicodeSets of text outside the context. In traditional terms, this allows anchoring at the start and/or end.

Constant Value: 65535 (0x0000ffff)

U_MATCH

public static final int U_MATCH

Constant returned by 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.

Constant Value: 2 (0x00000002)

U_MISMATCH

public static final int U_MISMATCH

Constant returned by 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.

Constant Value: 0 (0x00000000)

U_PARTIAL_MATCH

public static final int U_PARTIAL_MATCH

Constant returned by 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.

Constant Value: 1 (0x00000001)

addMatchSetTo

public abstract void addMatchSetTo (UnicodeSet toUnionTo)

Union the set of all characters that may be matched by this object into the given set.

matches

public 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. Zero, one, or more characters may be matched. Matching in the forward direction is indicated by limit > offset. Characters from offset forwards to limit-1 will be considered for matching. Matching in the reverse direction is indicated by limit < offset. Characters from offset backwards to limit+1 will be considered for matching. If limit == offset then the only match possible is a zero character match (which subclasses may implement if desired). If U_MATCH is returned, then as a side effect, advance the offset parameter to the limit of the matched substring. In the forward direction, this will be the index of the last matched character plus one. In the reverse direction, this will be the index of the last matched character minus one.

matchesIndexValue

public 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). This is used by RuleBasedTransliterator for indexing.

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).

toPattern

public abstract String toPattern (boolean escapeUnprintable)

Returns a string representation of this matcher. If the result of calling this function is passed to the appropriate parser, it will produce another matcher that is equal to this one.