Class UCharacterIteratorWrapper

java.lang.Object
com.ibm.icu.impl.UCharacterIteratorWrapper
All Implemented Interfaces:
Cloneable, CharacterIterator

public class UCharacterIteratorWrapper extends Object implements CharacterIterator
This class is a wrapper around UCharacterIterator and implements the CharacterIterator protocol
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
     

    Fields inherited from interface java.text.CharacterIterator

    DONE
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Create a copy of this iterator
    char
    Gets the character at the current position (as returned by getIndex()).
    char
    Sets the position to getBeginIndex() and returns the character at that position.
    int
    Returns the start index of the text.
    int
    Returns the end index of the text.
    int
    Returns the current index.
    char
    Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
    char
    Increments the iterator's index by one and returns the character at the new index.
    char
    Decrements the iterator's index by one and returns the character at the new index.
    char
    setIndex(int position)
    Sets the position to the specified position in the text and returns that character.

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

  • Method Details

    • first

      public char first()
      Sets the position to getBeginIndex() and returns the character at that position.
      Specified by:
      first in interface CharacterIterator
      Returns:
      the first character in the text, or DONE if the text is empty
      See Also:
    • last

      public char last()
      Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
      Specified by:
      last in interface CharacterIterator
      Returns:
      the last character in the text, or DONE if the text is empty
      See Also:
    • current

      public char current()
      Gets the character at the current position (as returned by getIndex()).
      Specified by:
      current in interface CharacterIterator
      Returns:
      the character at the current position or DONE if the current position is off the end of the text.
      See Also:
    • next

      public char next()
      Increments the iterator's index by one and returns 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.
      Specified by:
      next in interface CharacterIterator
      Returns:
      the character at the new position or DONE if the new position is off the end of the text range.
    • previous

      public char previous()
      Decrements the iterator's index by one and returns the character at the new index. If the current index is getBeginIndex(), the index remains at getBeginIndex() and a value of DONE is returned.
      Specified by:
      previous in interface CharacterIterator
      Returns:
      the character at the new position or DONE if the current position is equal to getBeginIndex().
    • setIndex

      public char setIndex(int position)
      Sets the position to the specified position in the text and returns that character.
      Specified by:
      setIndex in interface CharacterIterator
      Parameters:
      position - 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()
    • getBeginIndex

      public int getBeginIndex()
      Returns the start index of the text.
      Specified by:
      getBeginIndex in interface CharacterIterator
      Returns:
      the index at which the text begins.
    • getEndIndex

      public int getEndIndex()
      Returns the end index of the text. This index is the index of the first character following the end of the text.
      Specified by:
      getEndIndex in interface CharacterIterator
      Returns:
      the index after the last character in the text
    • getIndex

      public int getIndex()
      Returns the current index.
      Specified by:
      getIndex in interface CharacterIterator
      Returns:
      the current index.
    • clone

      public Object clone()
      Create a copy of this iterator
      Specified by:
      clone in interface CharacterIterator
      Overrides:
      clone in class Object
      Returns:
      A copy of this