com.ibm.icu.text
Class Transliterator.Position

java.lang.Object
  |
  +--com.ibm.icu.text.Transliterator.Position
Enclosing class:
Transliterator

public static class Transliterator.Position
extends java.lang.Object

Position structure for incremental transliteration. This data structure defines two substrings of the text being transliterated. The first region, [contextStart, contextLimit), defines what characters the transliterator will read as context. The second region, [start, limit), defines what characters will actually be transliterated. The second region should be a subset of the first.

After a transliteration operation, some of the indices in this structure will be modified. See the field descriptions for details.

contextStart <= start <= limit <= contextLimit

Note: All index values in this structure must be at code point boundaries. That is, none of them may occur between two code units of a surrogate pair. If any index does split a surrogate pair, results are unspecified.


Field Summary
 int contextLimit
          Ending index, exclusive, of the context to be considered for a transliteration operation.
 int contextStart
          Beginning index, inclusive, of the context to be considered for a transliteration operation.
 int limit
          Ending index, exclusive, of the text to be transliteratd.
 int start
          Beginning index, inclusive, of the text to be transliteratd.
 
Constructor Summary
Transliterator.Position()
           
Transliterator.Position(int contextStart, int contextLimit, int start)
           
Transliterator.Position(int contextStart, int contextLimit, int start, int limit)
           
 
Method Summary
 void validate(int length)
          Check all bounds.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

contextStart

public int contextStart
Beginning index, inclusive, of the context to be considered for a transliteration operation. The transliterator will ignore anything before this index. INPUT/OUTPUT parameter: This parameter is updated by a transliteration operation to reflect the maximum amount of antecontext needed by a transliterator.

contextLimit

public int contextLimit
Ending index, exclusive, of the context to be considered for a transliteration operation. The transliterator will ignore anything at or after this index. INPUT/OUTPUT parameter: This parameter is updated to reflect changes in the length of the text, but points to the same logical position in the text.

start

public int start
Beginning index, inclusive, of the text to be transliteratd. INPUT/OUTPUT parameter: This parameter is advanced past characters that have already been transliterated by a transliteration operation.

limit

public int limit
Ending index, exclusive, of the text to be transliteratd. INPUT/OUTPUT parameter: This parameter is updated to reflect changes in the length of the text, but points to the same logical position in the text.
Constructor Detail

Transliterator.Position

public Transliterator.Position()

Transliterator.Position

public Transliterator.Position(int contextStart,
                               int contextLimit,
                               int start)

Transliterator.Position

public Transliterator.Position(int contextStart,
                               int contextLimit,
                               int start,
                               int limit)
Method Detail

validate

public final void validate(int length)
Check all bounds. If they are invalid, throw an exception.
Parameters:
length - the length of the string this object applies to
Throws:
java.lang.IllegalArgumentException - if any indices are out of bounds


Copyright (c) 2001 IBM Corporation and others.