All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.text.CharacterIterator

public interface CharacterIterator

extends Cloneable

Examples:

Traverse the text from start to finish

public void traverseForward(CharacterIterator iter) {
     for(char c = iter.first(); c != CharacterIterator.DONE; c = iter.next()) {
         processChar(c);
     }
 }

public void traverseBackward(CharacterIterator iter) {
     for(char c = iter.last(); c != CharacterIterator.DONE; c = iter.prev()) {
         processChar(c);
     }
 }

public void traverseOut(CharacterIterator iter, int pos) {
     for (char c = iter.setIndex(pos);
          c != CharacterIterator.DONE && notBoundary(c);
          c = iter.next()) {}
 int end = iter.getIndex();
 for (char c = iter.setIndex(pos);
     c != CharacterIterator.DONE && notBoundary(c);
     c = iter.prev()) {}
 int start = iter.getIndex();
 processSection(start,end);
 }

See Also:

StringCharacterIterator

DONE

Constant that is returned when the iterator has reached either the end or the beginning of the text.

clone()

Create a copy of this iterator

current()

Get the character at the current position (as returned by getIndex()).

first()

Set the position to getBeginIndex() and return the character at that position.

getBeginIndex()

Return the start index of the text.

getEndIndex()

Return the end index of the text.

getIndex()

Return the current index.

last()

Set the position to getEndIndex()-1, return the character at that position.

next()

Increment the iterator's index by one and return the character at the new index.

previous()

Decrement the iterator's index by one and return the character at the new index.

setIndex(int)

Set the position to the specified position in the text and return that character.

public static final char DONE

Constant that is returned when the iterator has reached either the end or the beginning of the text. The unicode 2.0 standard states that '\\uFFFF' is an invalid unicode value and should not occur in any valid unicode string.

public abstract char first()

Set the position to getBeginIndex() and return the character at that position.

Returns:

the first character in the text

See Also:

getBeginIndex

public abstract char last()

Set the position to getEndIndex()-1, return the character at that position.

Returns:

the last character in the text

See Also:

getEndIndex

public abstract char current()

Get the character at the current position (as returned by getIndex()).

Returns:

the character at the current position or DONE if the current position is off the end of the text.

See Also:

getIndex

public abstract char next()

Increment the iterator's index by one and return the character at the new index. If the resulting index is greater or equal to getEndIndex(), the current index is reset to getEndIndex() and a value of DONE is returned.

Returns:

the character at the new position or DONE if the current position is off the end of the text.

public abstract char previous()

Decrement the iterator's index by one and return the character at the new index. If the resulting index is less than getBeginIndex(), the current index is reset to getBeginIndex() and a value of DONE is returned.

Returns:

the character at the new position or DONE if the current position is off the end of the text.

public abstract char setIndex(int position)

Set the position to the specified position in the text and return that character.

Parameters:

position - the position within the text. Valid values range from getBeginIndex() to getEndIndex() - 1. An IllegalArgumentException is thrown if an invalid value is supplied.

Returns:

the character at the specified position.

public abstract int getBeginIndex()

Return the start index of the text.

Returns:

the index at which the text begins.

public abstract int getEndIndex()

Return the end index of the text. This index is the index of the first character following the end of the text.

Returns:

the index at which the text end.

public abstract int getIndex()

Return the current index.

Returns:

the current index.

public abstract Object clone()

Create a copy of this iterator

Returns:

A copy of this

Overrides:

clone in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index