Package java.text

Interface CharacterIterator

All Superinterfaces:
Cloneable
All Known Subinterfaces:
AttributedCharacterIterator
All Known Implementing Classes:
StringCharacterIterator
public interface CharacterIterator
extends Cloneable
An interface for the bidirectional iteration over a group of characters. The iteration starts at the begin index in the group of characters and continues to one index before the end index.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static char DONE
    A constant which indicates that there is no character at the current index.

  • Method Summary

    Modifier and Type Method Description
    Object clone()
    Returns a new CharacterIterator with the same properties.
    char current()
    Returns the character at the current index.
    char first()
    Sets the current position to the begin index and returns the character at the new position.
    int getBeginIndex()
    Returns the begin index.
    int getEndIndex()
    Returns the end index.
    int getIndex()
    Returns the current index.
    char last()
    Sets the current position to the end index - 1 and returns the character at the new position.
    char next()
    Increments the current index and returns the character at the new index.
    char previous()
    Decrements the current index and returns the character at the new index.
    char setIndex​(int location)
    Sets the current index to a new position and returns the character at the new index.

  • Field Details

    • DONE

      static final char DONE
      A constant which indicates that there is no character at the current index.
      See Also:
      Constant Field Values

  • Method Details

    • clone

      Object clone()
      Returns a new CharacterIterator with the same properties.
      Returns:
      a shallow copy of this character iterator.
      See Also:
      Cloneable

    • current

      char current()
      Returns the character at the current index.
      Returns:
      the current character, or DONE if the current index is past the beginning or end of the sequence.

    • first

      char first()
      Sets the current position to the begin index and returns the character at the new position.
      Returns:
      the character at the begin index.

    • getBeginIndex

      int getBeginIndex()
      Returns the begin index.
      Returns:
      the index of the first character of the iteration.

    • getEndIndex

      int getEndIndex()
      Returns the end index.
      Returns:
      the index one past the last character of the iteration.

    • getIndex

      int getIndex()
      Returns the current index.
      Returns:
      the current index.

    • last

      char last()
      Sets the current position to the end index - 1 and returns the character at the new position.
      Returns:
      the character before the end index.

    • next

      char next()
      Increments the current index and returns the character at the new index.
      Returns:
      the character at the next index, or DONE if the next index would be past the end.

    • previous

      char previous()
      Decrements the current index and returns the character at the new index.
      Returns:
      the character at the previous index, or DONE if the previous index would be past the beginning.

    • setIndex

      char setIndex​(int location)
      Sets the current index to a new position and returns the character at the new index.
      Parameters:
      location - the new index that this character iterator is set to.
      Returns:
      the character at the new index, or DONE if the index is past the end.
      Throws:
      IllegalArgumentException - if location is less than the begin index or greater than the end index.