AttributedString.AttributedStringIterator

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.text
Class AttributedString.AttributedStringIterator

java.lang.Object
  java.text.AttributedString.AttributedStringIterator

All Implemented Interfaces:: AttributedCharacterIterator, CharacterIterator, Cloneable

Enclosing class:: AttributedString

private final class AttributedString.AttributedStringIterator
extends Object
implements AttributedCharacterIterator

Nested Class Summary

Nested classes inherited from class java.text.AttributedCharacterIterator

AttributedCharacterIterator.Attribute

Field Summary
`private int`	`beginIndex`
`private int`	`currentIndex`
`private int`	`currentRunIndex`
`private int`	`currentRunLimit`
`private int`	`currentRunStart`
`private int`	`endIndex`
`private AttributedCharacterIterator.Attribute[]`	`relevantAttributes`

Fields inherited from interface java.text.CharacterIterator

DONE

Constructor Summary
`(package private)`	`AttributedString.AttributedStringIterator(AttributedCharacterIterator.Attribute[] attributes, int beginIndex, int endIndex)`

Method Summary
`Object`	`clone()` Create a copy of this iterator
`char`	`current()` Gets the character at the current position (as returned by getIndex()).
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`char`	`first()` Sets the position to getBeginIndex() and returns the character at that position.
`Set`	`getAllAttributeKeys()` Returns the keys of all attributes defined on the iterator's text range.
`Object`	`getAttribute(AttributedCharacterIterator.Attribute attribute)` Returns the value of the named attribute for the current character.
`Map`	`getAttributes()` Returns a map with the attributes defined on the current character.
`int`	`getBeginIndex()` Returns the start index of the text.
`int`	`getEndIndex()` Returns the end index of the text.
`int`	`getIndex()` Returns the current index.
`int`	`getRunLimit()` Returns the index of the first character following the run with respect to all attributes containing the current character.
`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.
`int`	`getRunLimit(Set attributes)` Returns the index of the first character following the run with respect to the given attributes containing the current character.
`int`	`getRunStart()` Returns the index of the first character of the run with respect to all attributes containing the current character.
`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.
`int`	`getRunStart(Set attributes)` Returns the index of the first character of the run with respect to the given attributes containing the current character.
`private AttributedString`	`getString()`
`int`	`hashCode()` Returns a hash code value for the object.
`private char`	`internalSetIndex(int position)`
`char`	`last()` Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
`char`	`next()` Increments the iterator's index by one and returns the character at the new index.
`char`	`previous()` 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.
`private void`	`updateRunInfo()`

Methods inherited from class java.lang.Object

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

Field Detail

beginIndex

private int beginIndex

endIndex

private int endIndex

relevantAttributes

private AttributedCharacterIterator.Attribute[] relevantAttributes

currentIndex

private int currentIndex

currentRunIndex

private int currentRunIndex

currentRunStart

private int currentRunStart

currentRunLimit

private int currentRunLimit

Constructor Detail

AttributedString.AttributedStringIterator

AttributedString.AttributedStringIterator(AttributedCharacterIterator.Attribute[] attributes,
                                          int beginIndex,
                                          int endIndex)

Method Detail

equals

public boolean equals(Object obj)

Description copied from class: Object

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.

Overrides:: equals in class Object

Parameters:: obj - the reference object with which to compare.
Returns:: true if this object is the same as the obj argument; false otherwise.
See Also:: Object.hashCode(), Hashtable

hashCode

public int hashCode()

Description copied from class: Object

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 Java^TM programming language.)

Overrides:: hashCode in class Object

Returns:: a hash code value for this object.
See Also:: Object.equals(java.lang.Object), Hashtable