Interface AttributedCharacterIterator

All Superinterfaces:: CharacterIterator, Cloneable

public interface AttributedCharacterIterator extends CharacterIterator

An AttributedCharacterIterator allows iteration through both text and related attribute information.

An attribute is a key/value pair, identified by the key. No two attributes on a given character can have the same key.

The values for an attribute are immutable, or must not be mutated by clients or storage. They are always passed by reference, and not cloned.

A run with respect to an attribute is a maximum text range for which:

the attribute is undefined or null for the entire range, or
the attribute value is defined and has the same non-null value for the entire range.

A run with respect to a set of attributes is a maximum text range for which this condition is met for each member attribute.

When getting a run with no explicit attributes specified (i.e., calling getRunStart() and getRunLimit()), any contiguous text segments having the same attributes (the same set of attribute/value pairs) are treated as separate runs if the attributes have been given to those text segments separately.

The returned indexes are limited to the range of the iterator.

The returned attribute information is limited to runs that contain the current character.

Attribute keys are instances of AttributedCharacterIterator.Attribute and its subclasses, such as TextAttribute.

Since:

1.2

See Also:

Nested Class Summary

Modifier and Type	Interface	Description
`static class`	`AttributedCharacterIterator.Attribute`	Defines attribute keys that are used to identify text attributes.

Field Summary

Fields declared in interface CharacterIterator

DONE

Modifier and Type	Field	Description
`static final char`	`DONE`	Constant that is returned when the iterator has reached either the end or the beginning of the text.

Method Summary

Modifier and Type	Method	Description
`Set<AttributedCharacterIterator.Attribute>`	`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<AttributedCharacterIterator.Attribute, Object>`	`getAttributes()`	Returns a map with the attributes defined on the current character.
`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<? extends AttributedCharacterIterator.Attribute> 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<? extends AttributedCharacterIterator.Attribute> attributes)`	Returns the index of the first character of the run with respect to the given `attributes` containing the current character.

Methods declared in interface CharacterIterator

clone, current, first, getBeginIndex, getEndIndex, getIndex, last, next, previous, setIndex

Modifier and Type	Method	Description
`Object`	`clone()`	Create a copy of this iterator
`char`	`current()`	Gets the character at the current position (as returned by getIndex()).
`char`	`first()`	Sets the position to getBeginIndex() and returns the character at that position.
`int`	`getBeginIndex()`	Returns the start index of the text.
`int`	`getEndIndex()`	Returns the end index of the text.
`int`	`getIndex()`	Returns the current index.
`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.

Method Details

getRunStart

int getRunStart()

Returns the index of the first character of the run with respect to all attributes containing the current character.

Any contiguous text segments having the same attributes (the same set of attribute/value pairs) are treated as separate runs if the attributes have been given to those text segments separately.

Returns:: the index of the first character of the run

getRunStart

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.

Parameters:: attribute - the desired attribute.
Returns:: the index of the first character of the run

getRunStart

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.

Parameters:: attributes - a set of the desired attributes.
Returns:: the index of the first character of the run

getRunLimit

int getRunLimit()

Returns the index of the first character following the run with respect to all attributes containing the current character.

Any contiguous text segments having the same attributes (the same set of attribute/value pairs) are treated as separate runs if the attributes have been given to those text segments separately.

Returns:: the index of the first character following the run

getRunLimit

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.

Parameters:: attribute - the desired attribute
Returns:: the index of the first character following the run

getRunLimit

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.

Parameters:: attributes - a set of the desired attributes
Returns:: the index of the first character following the run

getAttributes

Map<AttributedCharacterIterator.Attribute, Object> getAttributes()

Returns a map with the attributes defined on the current character.

Returns:: a map with the attributes defined on the current character

getAttribute

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:: attribute - the desired attribute
Returns:: the value of the named attribute or null

getAllAttributeKeys

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.

Returns:: the keys of all attributes

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.