public class

ReplaceableUCharacterIterator

extends UCharacterIterator
java.lang.Object
   ↳ sun.text.normalizer.UCharacterIterator
     ↳ sun.text.normalizer.ReplaceableUCharacterIterator

Class Overview

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?!?!?!

Summary

[Expand]
Inherited Constants
From class sun.text.normalizer.UCharacterIterator
Public Constructors
ReplaceableUCharacterIterator(String str)
Public constructor
ReplaceableUCharacterIterator(StringBuffer buf)
Public constructor
Public Methods
Object clone()
Creates a copy of this iterator, does not clone the underlying Replaceableobject
int current()
Returns the current UTF16 character.
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.

[Expand]
Inherited Methods
From class sun.text.normalizer.UCharacterIterator
From class java.lang.Object

Public Constructors

public ReplaceableUCharacterIterator (String str)

Public constructor

Parameters
str text which the iterator will be based on

public ReplaceableUCharacterIterator (StringBuffer buf)

Public constructor

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

Public Methods

public Object clone ()

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

Returns
  • copy of this iterator

public int current ()

Returns the current UTF16 character.

Returns
  • current UTF16 character

public int getIndex ()

Gets the current currentIndex in text.

Returns
  • current currentIndex in text.

public int getLength ()

Returns the length of the text

Returns
  • length of the text

public 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. 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 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

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.

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

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.

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

public void setIndex (int currentIndex)

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.

Parameters
currentIndex the currentIndex within the text.
Returns
  • the character at the specified currentIndex or DONE if the specified currentIndex is equal to the end of the text.
Throws
IllegalArgumentException is thrown if an invalid currentIndex is supplied. i.e. currentIndex is out of bounds.