This class is not part of the public API.

Class: java.text.AttributedString.AttributedStringIterator

Inheritance

Superclass tree: Implements:

Methods

  • AttributedString.AttributedStringIteratortop

    AttributedString.AttributedStringIterator(AttributedCharacterIterator.Attribute[] attributes, int beginIndex, int endIndex)
    Related Links:
    Google Code Search
    Stack Overflow

  • clonetop

    public Object clone()
    Create a copy of this iterator
    Return:
    @return A copy of this
    Specified by:
    clone from CharacterIterator
    Override hierarchy:
    clone from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • currenttop

    public char current()
    Gets the character at the current position (as returned by getIndex()).
    Return:
    @return the character at the current position or DONE if the current position is off the end of the text.
    Specified by:
    current from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • equalstop

    public boolean equals(Object obj)
    Indicates whether some other object is "equal to" this one.

    The equals method implements an equivalence relation on non-null object references:

    • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    • For any non-null reference value x, x.equals(null) should return false.

    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

    Parameters:
    @param obj the reference object with which to compare.
    Return:
    @return true if this object is the same as the obj argument; false otherwise.
    Override hierarchy:
    equals from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • firsttop

    public char first()
    Sets the position to getBeginIndex() and returns the character at that position.
    Return:
    @return the first character in the text, or DONE if the text is empty
    Specified by:
    first from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getAllAttributeKeystop

    public Set<AttributedCharacterIterator.Attribute> getAllAttributeKeys()
    Returns the keys of all attributes defined on the iterator's text range. The set is empty if no attributes are defined.
    Specified by:
    getAllAttributeKeys from AttributedCharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getAttributetop

    public Object getAttribute(AttributedCharacterIterator.Attribute attribute)
    Returns the value of the named attribute for the current character. Returns null if the attribute is not defined.
    Parameters:
    @param attribute the key of the attribute whose value is requested.
    Specified by:
    getAttribute from AttributedCharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getAttributestop

    public Map<AttributedCharacterIterator.Attribute, Object> getAttributes()
    Returns a map with the attributes defined on the current character.
    Specified by:
    getAttributes from AttributedCharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getBeginIndextop

    public int getBeginIndex()
    Returns the start index of the text.
    Return:
    @return the index at which the text begins.
    Specified by:
    getBeginIndex from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getEndIndextop

    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.
    Return:
    @return the index after the last character in the text
    Specified by:
    getEndIndex from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getIndextop

    public int getIndex()
    Returns the current index.
    Return:
    @return the current index.
    Specified by:
    getIndex from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getRunLimittop

    public int getRunLimit()
    Returns the index of the first character following the run with respect to all attributes containing the current character.
    Specified by:
    getRunLimit from AttributedCharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getRunLimittop

    public int getRunLimit(AttributedCharacterIterator.Attribute attribute)
    Returns the index of the first character following the run with respect to the given attribute containing the current character.
    Specified by:
    getRunLimit from AttributedCharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getRunLimittop

    public int getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)
    Returns the index of the first character following the run with respect to the given attributes containing the current character.
    Specified by:
    getRunLimit from AttributedCharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getRunStarttop

    public int getRunStart()
    Returns the index of the first character of the run with respect to all attributes containing the current character.
    Specified by:
    getRunStart from AttributedCharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getRunStarttop

    public int getRunStart(AttributedCharacterIterator.Attribute attribute)
    Returns the index of the first character of the run with respect to the given attribute containing the current character.
    Specified by:
    getRunStart from AttributedCharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getRunStarttop

    public int getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)
    Returns the index of the first character of the run with respect to the given attributes containing the current character.
    Specified by:
    getRunStart from AttributedCharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • getStringtop

    private AttributedString getString()
    Related Links:
    Google Code Search
    Stack Overflow

  • hashCodetop

    public int hashCode()
    Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

    The general contract of hashCode is:

    • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    • It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

    Return:
    @return a hash code value for this object.
    Override hierarchy:
    hashCode from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • internalSetIndextop

    private char internalSetIndex(int position)
    Related Links:
    Google Code Search
    Stack Overflow

  • lasttop

    public char last()
    Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
    Return:
    @return the last character in the text, or DONE if the text is empty
    Specified by:
    last from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • nexttop

    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.
    Return:
    @return the character at the new position or DONE if the new position is off the end of the text range.
    Specified by:
    next from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • previoustop

    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.
    Return:
    @return the character at the new position or DONE if the current position is equal to getBeginIndex().
    Specified by:
    previous from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • setIndextop

    public char setIndex(int position)
    Sets the position to the specified position in the text and returns that character.
    Parameters:
    @param position the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied.
    Return:
    @return the character at the specified position or DONE if the specified position is equal to getEndIndex()
    Specified by:
    setIndex from CharacterIterator
    Related Links:
    Google Code Search
    Stack Overflow

  • updateRunInfotop

    private void updateRunInfo()
    Related Links:
    Google Code Search
    Stack Overflow

Fields

  • beginIndex

    private int beginIndex

  • currentIndex

    private int currentIndex

  • currentRunIndex

    private int currentRunIndex

  • currentRunLimit

    private int currentRunLimit

  • currentRunStart

    private int currentRunStart

  • endIndex

    private int endIndex

  • relevantAttributes

    private AttributedCharacterIterator.Attribute[] relevantAttributes