public final Class UCharArrayIterator

Overrides com.ibm.icu.text.UCharacterIterator.clone.

Creates a copy of this iterator, does not clone the underlying Replaceableobject

Returns:Object

copy of this iterator

Annotations

@Override

Implements abstract com.ibm.icu.text.UCharacterIterator.current.

Doc from com.ibm.icu.text.UCharacterIterator.current.

Returns the code unit at the current index. If index is out of range, returns DONE. Index is not changed.

Returns:int

current code unit

Annotations

@Override

Implements abstract com.ibm.icu.text.UCharacterIterator.getIndex.

Doc from com.ibm.icu.text.UCharacterIterator.getIndex.

Gets the current index in text.

Returns:int

current index in text.

Annotations

@Override

Implements abstract com.ibm.icu.text.UCharacterIterator.getLength.

Doc from com.ibm.icu.text.UCharacterIterator.getLength.

Returns the length of the text

Returns:int

length of the text

Annotations

@Override

Implements abstract com.ibm.icu.text.UCharacterIterator.getText.

Doc from com.ibm.icu.text.UCharacterIterator.getText.

Fills the buffer with the underlying text storage of the iterator If the buffer capacity is not enough a exception is thrown. The capacity of the fill in buffer should at least be equal to length of text in the iterator obtained by calling getLength()). Usage:

        UChacterIterator iter = new UCharacterIterator.getInstance(text);
        char[] buf = new char[iter.getLength()];
        iter.getText(buf);

        OR
        char[] buf= new char[1];
        int len = 0;
        for(;;){
            try{
                len = iter.getText(buf);
                break;
            }catch(IndexOutOfBoundsException e){
                buf = new char[iter.getLength()];
            }
        }

Parameters

fillIn:char[]

an array of chars to fill with the underlying UTF-16 code units.

offset:int

the position within the array to start putting the data.

Returns:int

the number of code units added to fillIn, as a convenience

Annotations

@Override

Implements abstract com.ibm.icu.text.UCharacterIterator.next.

Implements com.ibm.icu.text.UForwardCharacterIterator.next.

Doc from com.ibm.icu.text.UCharacterIterator.next.

Returns the UTF16 code unit at index, and increments to the next code unit (post-increment semantics). If index is out of range, DONE is returned, and the iterator is reset to the limit of the text.

Returns:int

the next UTF16 code unit, or DONE if the index is at the limit of the text.

Annotations

@Override

Implements abstract com.ibm.icu.text.UCharacterIterator.previous.

Doc from com.ibm.icu.text.UCharacterIterator.previous.

Decrement to the position of the previous code unit in the text, and return it (pre-decrement semantics). If the resulting index is less than 0, the index is reset to 0 and DONE is returned.

Returns:int

the previous code unit in the text, or DONE if the new index is before the start of the text.

Annotations

@Override

Implements abstract com.ibm.icu.text.UCharacterIterator.setIndex.

Doc from com.ibm.icu.text.UCharacterIterator.setIndex.

Sets the index to the specified index in the text.

Parameters

index:int

the index within the text.

Annotations

@Override