01: /*
02: **********************************************************************
03: * Copyright (c) 2002, International Business Machines Corporation
04: * and others. All Rights Reserved.
05: **********************************************************************
06: * Date Name Description
07: * 01/14/2002 aliu Creation.
08: **********************************************************************
09: */
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, int start, int limit,
40: int[] cursor);
41:
42: /**
43: * Returns a string representation of this replacer. If the
44: * result of calling this function is passed to the appropriate
45: * parser, typically TransliteratorParser, it will produce another
46: * replacer that is equal to this one.
47: * @param escapeUnprintable if TRUE then convert unprintable
48: * character to their hex escape representations, \\uxxxx or
49: * \\Uxxxxxxxx. Unprintable characters are defined by
50: * Utility.isUnprintable().
51: */
52: public abstract String toReplacerPattern(boolean escapeUnprintable);
53:
54: /**
55: * Union the set of all characters that may output by this object
56: * into the given set.
57: * @param toUnionTo the set into which to union the output characters
58: */
59: public abstract void addReplacementSetTo(UnicodeSet toUnionTo);
60: }
61:
62: //eof
|