com.ibm.icu.impl

Class ReplaceableUCharacterIterator

java.lang.Object

com.ibm.icu.text.UCharacterIterator

com.ibm.icu.impl.ReplaceableUCharacterIterator

All Implemented Interfaces:

UForwardCharacterIterator, Cloneable

public class ReplaceableUCharacterIterator
extends UCharacterIterator

DLF docs must define behavior when Replaceable is mutated underneath the iterator. This and ICUCharacterIterator share some code, maybe they should share an implementation, or the common state and implementation should be moved up into UCharacterIterator. What are first, last, and getBeginIndex doing here?!?!?!

Field Summary

Fields inherited from interface com.ibm.icu.text.UForwardCharacterIterator

DONE

Constructor Summary

Constructors

Constructor and Description
ReplaceableUCharacterIterator(Replaceable replaceable) Public constructor
ReplaceableUCharacterIterator(String str) Public constructor
ReplaceableUCharacterIterator(StringBuffer buf) Public constructor

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a copy of this iterator, does not clone the underlying Replaceableobject
int	current() Returns the current UTF16 character.
int	currentCodePoint() Returns the current codepoint
int	getIndex() Gets the current currentIndex in text.
int	getLength() Returns the length of the text
int	getText(char[] fillIn, int offset) Fills the buffer with the underlying text storage of the iterator If the buffer capacity is not enough a exception is thrown.
int	next() Returns next UTF16 character and increments the iterator's currentIndex by 1.
int	previous() Returns previous UTF16 character and decrements the iterator's currentIndex by 1.
void	setIndex(int currentIndex) Sets the currentIndex to the specified currentIndex in the text and returns that single UTF16 character at currentIndex.

Methods inherited from class com.ibm.icu.text.UCharacterIterator

getCharacterIterator, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getText, getText, moveCodePointIndex, moveIndex, nextCodePoint, previousCodePoint, setToLimit, setToStart

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReplaceableUCharacterIterator

public ReplaceableUCharacterIterator(Replaceable replaceable)

Public constructor

Parameters:

replaceable - text which the iterator will be based on

ReplaceableUCharacterIterator

public ReplaceableUCharacterIterator(String str)

Public constructor

Parameters:

str - text which the iterator will be based on

ReplaceableUCharacterIterator

public ReplaceableUCharacterIterator(StringBuffer buf)

Public constructor

Parameters:

buf - buffer of text on which the iterator will be based

Method Detail

clone

public Object clone()

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

Overrides:

clone in class UCharacterIterator

Returns:

copy of this iterator

current

public int current()

Returns the current UTF16 character.

Specified by:

current in class UCharacterIterator

Returns:

current UTF16 character

currentCodePoint

public int currentCodePoint()

Returns the current codepoint

Overrides:

currentCodePoint in class UCharacterIterator

Returns:

current codepoint

getLength

public int getLength()

Returns the length of the text

Specified by:

getLength in class UCharacterIterator

Returns:

length of the text

getIndex

public int getIndex()

Gets the current currentIndex in text.

Specified by:

getIndex in class UCharacterIterator

Returns:

current currentIndex in text.

next

public int next()

Returns next UTF16 character and increments the iterator's currentIndex by 1. If the resulting currentIndex is greater or equal to the text length, the currentIndex is reset to the text length and a value of DONECODEPOINT is returned.

Specified by:

next in interface UForwardCharacterIterator

Specified by:

next in class UCharacterIterator

Returns:

next UTF16 character in text or DONE if the new currentIndex is off the end of the text range.

previous

public int previous()

Returns previous UTF16 character and decrements the iterator's currentIndex by 1. If the resulting currentIndex is less than 0, the currentIndex is reset to 0 and a value of DONECODEPOINT is returned.

Specified by:

previous in class UCharacterIterator

Returns:

next UTF16 character in text or DONE if the new currentIndex is off the start of the text range.

setIndex

public void setIndex(int currentIndex)
              throws IndexOutOfBoundsException

Sets the currentIndex to the specified currentIndex in the text and returns that single UTF16 character at currentIndex. This assumes the text is stored as 16-bit code units.

Specified by:

setIndex in class UCharacterIterator

Parameters:

currentIndex - the currentIndex within the text.

Throws:

IllegalArgumentException - is thrown if an invalid currentIndex is supplied. i.e. currentIndex is out of bounds.

IndexOutOfBoundsException - is thrown if an invalid index is supplied

getText

public int getText(char[] fillIn,
                   int offset)

Description copied from class: UCharacterIterator

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()];
             }
         }
 

Specified by:

getText in class UCharacterIterator

Parameters:

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

offset - the position within the array to start putting the data.

Returns:

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