KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ibm > icu > text > UnicodeReplacer


1 /*
2 **********************************************************************
3 * Copyright (c) 2002, International Business Machines Corporation
4 * and others. All Rights Reserved.
5 **********************************************************************
6 * Date Name Description
7 * 01/14/2002 aliu Creation.
8 **********************************************************************
9 */
10
11 package com.ibm.icu.text;
12
13 /**
14  * <code>UnicodeReplacer</code> defines a protocol for objects that
15  * replace a range of characters in a Replaceable string with output
16  * text. The replacement is done via the Replaceable API so as to
17  * preserve out-of-band data.
18  * @author Alan Liu
19  */
20 interface UnicodeReplacer {
21
22     /**
23      * Replace characters in 'text' from 'start' to 'limit' with the
24      * output text of this object. Update the 'cursor' parameter to
25      * give the cursor position and return the length of the
26      * replacement text.
27      *
28      * @param text the text to be matched
29      * @param start inclusive start index of text to be replaced
30      * @param limit exclusive end index of text to be replaced;
31      * must be greater than or equal to start
32      * @param cursor output parameter for the cursor position.
33      * Not all replacer objects will update this, but in a complete
34      * tree of replacer objects, representing the entire output side
35      * of a transliteration rule, at least one must update it.
36      * @return the number of 16-bit code units in the text replacing
37      * the characters at offsets start..(limit-1) in text
38      */
39     public abstract int replace(Replaceable text,
40                                 int start,
41                                 int limit,
42                                 int[] cursor);
43
44     /**
45      * Returns a string representation of this replacer. If the
46      * result of calling this function is passed to the appropriate
47      * parser, typically TransliteratorParser, it will produce another
48      * replacer that is equal to this one.
49      * @param escapeUnprintable if TRUE then convert unprintable
50      * character to their hex escape representations, \\uxxxx or
51      * \\Uxxxxxxxx. Unprintable characters are defined by
52      * Utility.isUnprintable().
53      */
54     public abstract String JavaDoc toReplacerPattern(boolean escapeUnprintable);
55
56     /**
57      * Union the set of all characters that may output by this object
58      * into the given set.
59      * @param toUnionTo the set into which to union the output characters
60      */
61     public abstract void addReplacementSetTo(UnicodeSet toUnionTo);
62 }
63
64 //eof
65
Popular Tags