CharacterIterator

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> java >> [ text overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of java.text.CharacterIterator

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.text
Interface CharacterIterator

All Superinterfaces:: java.lang.Cloneable

All Known Subinterfaces:: AttributedCharacterIterator

All Known Implementing Classes:: AttributedStringIterator, StringCharacterIterator

public interface CharacterIterator
extends java.lang.Cloneable

This interface defines a mechanism for iterating over a range of characters. For a given range of text, a beginning and ending index, as well as a current index are defined. These values can be queried by the methods in this interface. Additionally, various methods allow the index to be set.

Field Summary

static char DONE
          This is a special constant value that is returned when the beginning or end of the character range has been reached.

Method Summary

java.lang.Object clone()
          This method creates a copy of this CharacterIterator.

char current()
          This method returns the character at the current index position

char first()
          This method sets the index value to the beginning of the range and returns the character there.

int getBeginIndex()
          This method returns the character position of the first character in the range.

int getEndIndex()
          This method returns the character position of the end of the text range.

int getIndex()
          This method returns the current value of the index.

char last()
          This method sets the index value to getEndIndex() - 1 and returns the character there.

char next()
          This method increments the current index and then returns the character at the new index value.

char previous()
          This method decrements the current index and then returns the character at the new index value.

char setIndex(int index)
          This method sets the value of the index to the specified value, then returns the character at that position.

Field Detail

DONE

public static final char DONE

This is a special constant value that is returned when the beginning or end of the character range has been reached.

See Also:: Constant Field Values

Method Detail

current

public char current()

This method returns the character at the current index position

public char next()

This method increments the current index and then returns the character at the new index value. If the index is already at getEndIndex() - 1, it will not be incremented.

public char previous()

This method decrements the current index and then returns the character at the new index value. If the index value is already at the beginning index, it will not be decremented.

first

public char first()

This method sets the index value to the beginning of the range and returns the character there.

last

public char last()

This method sets the index value to getEndIndex() - 1 and returns the character there. If the range is empty, then the index value will be set equal to the beginning index.

getIndex

public int getIndex()

This method returns the current value of the index.

setIndex

public char setIndex(int index)
              throws java.lang.IllegalArgumentException

This method sets the value of the index to the specified value, then returns the character at that position.

getBeginIndex

public int getBeginIndex()

This method returns the character position of the first character in the range.

getEndIndex

public int getEndIndex()

This method returns the character position of the end of the text range. This will actually be the index of the first character following the end of the range. In the event the text range is empty, this will be equal to the first character in the range.

clone

public java.lang.Object clone()

This method creates a copy of this CharacterIterator.