Module java.base
Package java.text

Class StringCharacterIterator

java.lang.Object
java.text.StringCharacterIterator
All Implemented Interfaces:
Cloneable, CharacterIterator
public final class StringCharacterIterator
extends Object
implements CharacterIterator
StringCharacterIterator implements the CharacterIterator protocol for a String. The StringCharacterIterator class iterates over the entire String.
Since:
1.1
See Also:
CharacterIterator

  • Field Summary

    Fields declared in interface java.text.CharacterIterator

    DONE

  • Constructor Summary

    Constructors 
    Constructor Description
    StringCharacterIterator​(String text)
    Constructs an iterator with an initial index of 0.
    StringCharacterIterator​(String text, int pos)
    Constructs an iterator with the specified initial index.
    StringCharacterIterator​(String text, int begin, int end, int pos)
    Constructs an iterator over the given range of the given string, with the index set at the specified position.

  • Method Summary

    Modifier and Type Method Description
    Object clone()
    Creates a copy of this iterator.
    char current()
    Implements CharacterIterator.current() for String.
    boolean equals​(Object obj)
    Compares the equality of two StringCharacterIterator objects.
    char first()
    Implements CharacterIterator.first() for String.
    int getBeginIndex()
    Implements CharacterIterator.getBeginIndex() for String.
    int getEndIndex()
    Implements CharacterIterator.getEndIndex() for String.
    int getIndex()
    Implements CharacterIterator.getIndex() for String.
    int hashCode()
    Computes a hashcode for this iterator.
    char last()
    Implements CharacterIterator.last() for String.
    char next()
    Implements CharacterIterator.next() for String.
    char previous()
    Implements CharacterIterator.previous() for String.
    char setIndex​(int p)
    Implements CharacterIterator.setIndex() for String.
    void setText​(String text)
    Reset this iterator to point to a new string.

    Methods declared in class java.lang.Object

    finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • StringCharacterIterator

      public StringCharacterIterator​(String text)
      Constructs an iterator with an initial index of 0.
      Parameters:
      text - the String to be iterated over

    • StringCharacterIterator

      public StringCharacterIterator​(String text, int pos)
      Constructs an iterator with the specified initial index.
      Parameters:
      text - The String to be iterated over
      pos - Initial iterator position

    • StringCharacterIterator

      public StringCharacterIterator​(String text, int begin, int end, int pos)
      Constructs an iterator over the given range of the given string, with the index set at the specified position.
      Parameters:
      text - The String to be iterated over
      begin - Index of the first character
      end - Index of the character following the last character
      pos - Initial iterator position

  • Method Details