Top Description Methods
com.ibm.icu.text

pack-priv Interface UnicodeReplacer

Known Direct Implementers
com.ibm.icu.text.FunctionReplacer, com.ibm.icu.text.StringMatcher, com.ibm.icu.text.StringReplacer

UnicodeReplacer defines a protocol for objects that replace a range of characters in a Replaceable string with output text. The replacement is done via the Replaceable API so as to preserve out-of-band data.
Author
Alan Liu

Method Summary

Modifier and TypeMethod and Description
public void
addReplacementSetTo(UnicodeSet
the set into which to union the output characters
toUnionTo
)

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

public int

Returns:

the number of 16-bit code units in the text replacing the characters at offsets start..(limit-1) in text
replace
(Replaceable
the text to be matched
text
,
int
inclusive start index of text to be replaced
start
,
int
exclusive end index of text to be replaced; must be greater than or equal to start
limit
,
int[]
output parameter for the cursor position. Not all replacer objects will update this, but in a complete tree of replacer objects, representing the entire output side of a transliteration rule, at least one must update it.
cursor
)

Replace characters in 'text' from 'start' to 'limit' with the output text of this object.

public String
toReplacerPattern(boolean
if true then convert unprintable character to their hex escape representations, \\uxxxx or \\Uxxxxxxxx. Unprintable characters are defined by Utility.isUnprintable().
escapeUnprintable
)

Returns a string representation of this replacer.

Method Detail

addReplacementSetToback to summary
public void addReplacementSetTo(UnicodeSet toUnionTo)

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

Parameters
toUnionTo:UnicodeSet

the set into which to union the output characters

replaceback to summary
public int replace(Replaceable text, int start, int limit, int[] cursor)

Replace characters in 'text' from 'start' to 'limit' with the output text of this object. Update the 'cursor' parameter to give the cursor position and return the length of the replacement text.

Parameters
text:Replaceable

the text to be matched

start:int

inclusive start index of text to be replaced

limit:int

exclusive end index of text to be replaced; must be greater than or equal to start

cursor:int[]

output parameter for the cursor position. Not all replacer objects will update this, but in a complete tree of replacer objects, representing the entire output side of a transliteration rule, at least one must update it.

Returns:int

the number of 16-bit code units in the text replacing the characters at offsets start..(limit-1) in text

toReplacerPatternback to summary
public String toReplacerPattern(boolean escapeUnprintable)

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

Parameters
escapeUnprintable:boolean

if true then convert unprintable character to their hex escape representations, \\uxxxx or \\Uxxxxxxxx. Unprintable characters are defined by Utility.isUnprintable().