StringCharacterIterator (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.text.StringCharacterIterator

• All Implemented Interfaces:
  Cloneable, CharacterIterator

public final class StringCharacterIterator
extends Object
implements CharacterIterator
StringCharacterIterator implements theCharacterIterator protocol for a String. The StringCharacterIterator class iterates over the entire String.
See Also:
CharacterIterator

• • Field Summary

     * ### Fields inherited from interface java.text.[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")  
     `[DONE](../../java/text/CharacterIterator.html#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

  All Methods Instance Methods Concrete Methods

  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 inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [toString](../../java/lang/Object.html#toString--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### StringCharacterIterator  
     public StringCharacterIterator([String](../../java/lang/String.html "class in java.lang") text)  
     Constructs an iterator with an initial index of 0.  
     Parameters:  
     `text` \- the `String` to be iterated over  
     * #### StringCharacterIterator  
     public StringCharacterIterator([String](../../java/lang/String.html "class in java.lang") 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](../../java/lang/String.html "class in java.lang") 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 Detail

    * #### setText  
    public void setText([String](../../java/lang/String.html "class in java.lang") text)  
    Reset this iterator to point to a new string. This package-visible method is used by other java.text classes that want to avoid allocating new StringCharacterIterator objects every time their setText method is called.  
    Parameters:  
    `text` \- The String to be iterated over  
    Since:  
    1.2  
    * #### first  
    public char first()  
    Implements CharacterIterator.first() for String.  
    Specified by:  
    `[first](../../java/text/CharacterIterator.html#first--)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Returns:  
    the first character in the text, or DONE if the text is empty  
    See Also:  
    [CharacterIterator.first()](../../java/text/CharacterIterator.html#first--)  
    * #### last  
    public char last()  
    Implements CharacterIterator.last() for String.  
    Specified by:  
    `[last](../../java/text/CharacterIterator.html#last--)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Returns:  
    the last character in the text, or DONE if the text is empty  
    See Also:  
    [CharacterIterator.last()](../../java/text/CharacterIterator.html#last--)  
    * #### setIndex  
    public char setIndex(int p)  
    Implements CharacterIterator.setIndex() for String.  
    Specified by:  
    `[setIndex](../../java/text/CharacterIterator.html#setIndex-int-)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Parameters:  
    `p` \- the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied.  
    Returns:  
    the character at the specified position or DONE if the specified position is equal to getEndIndex()  
    See Also:  
    [CharacterIterator.setIndex(int)](../../java/text/CharacterIterator.html#setIndex-int-)  
    * #### current  
    public char current()  
    Implements CharacterIterator.current() for String.  
    Specified by:  
    `[current](../../java/text/CharacterIterator.html#current--)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Returns:  
    the character at the current position or DONE if the current position is off the end of the text.  
    See Also:  
    [CharacterIterator.current()](../../java/text/CharacterIterator.html#current--)  
    * #### next  
    public char next()  
    Implements CharacterIterator.next() for String.  
    Specified by:  
    `[next](../../java/text/CharacterIterator.html#next--)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Returns:  
    the character at the new position or DONE if the new position is off the end of the text range.  
    See Also:  
    [CharacterIterator.next()](../../java/text/CharacterIterator.html#next--)  
    * #### previous  
    public char previous()  
    Implements CharacterIterator.previous() for String.  
    Specified by:  
    `[previous](../../java/text/CharacterIterator.html#previous--)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Returns:  
    the character at the new position or DONE if the current position is equal to getBeginIndex().  
    See Also:  
    [CharacterIterator.previous()](../../java/text/CharacterIterator.html#previous--)  
    * #### getBeginIndex  
    public int getBeginIndex()  
    Implements CharacterIterator.getBeginIndex() for String.  
    Specified by:  
    `[getBeginIndex](../../java/text/CharacterIterator.html#getBeginIndex--)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Returns:  
    the index at which the text begins.  
    See Also:  
    [CharacterIterator.getBeginIndex()](../../java/text/CharacterIterator.html#getBeginIndex--)  
    * #### getEndIndex  
    public int getEndIndex()  
    Implements CharacterIterator.getEndIndex() for String.  
    Specified by:  
    `[getEndIndex](../../java/text/CharacterIterator.html#getEndIndex--)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Returns:  
    the index after the last character in the text  
    See Also:  
    [CharacterIterator.getEndIndex()](../../java/text/CharacterIterator.html#getEndIndex--)  
    * #### getIndex  
    public int getIndex()  
    Implements CharacterIterator.getIndex() for String.  
    Specified by:  
    `[getIndex](../../java/text/CharacterIterator.html#getIndex--)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Returns:  
    the current index.  
    See Also:  
    [CharacterIterator.getIndex()](../../java/text/CharacterIterator.html#getIndex--)  
    * #### equals  
    public boolean equals([Object](../../java/lang/Object.html "class in java.lang") obj)  
    Compares the equality of two StringCharacterIterator objects.  
    Overrides:  
    `[equals](../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Parameters:  
    `obj` \- the StringCharacterIterator object to be compared with.  
    Returns:  
    true if the given obj is the same as this StringCharacterIterator object; false otherwise.  
    See Also:  
    [Object.hashCode()](../../java/lang/Object.html#hashCode--), [HashMap](../../java/util/HashMap.html "class in java.util")  
    * #### hashCode  
    public int hashCode()  
    Computes a hashcode for this iterator.  
    Overrides:  
    `[hashCode](../../java/lang/Object.html#hashCode--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    A hash code  
    See Also:  
    [Object.equals(java.lang.Object)](../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../java/lang/System.html#identityHashCode-java.lang.Object-)  
    * #### clone  
    public [Object](../../java/lang/Object.html "class in java.lang") clone()  
    Creates a copy of this iterator.  
    Specified by:  
    `[clone](../../java/text/CharacterIterator.html#clone--)` in interface `[CharacterIterator](../../java/text/CharacterIterator.html "interface in java.text")`  
    Overrides:  
    `[clone](../../java/lang/Object.html#clone--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    A copy of this  
    See Also:  
    [Cloneable](../../java/lang/Cloneable.html "interface in java.lang")

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.