Text of docs.oracle.com › javase › 8 › docs › api › java › text › AttributedCharacterIterator.html as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout.

Open the live page

AttributedCharacterIterator (Java Platform SE 8 )

Skip navigation links Overview Package Class Use Tree Deprecated Index Help Java™ Platform Standard Ed. 8 Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method compact1, compact2, compact3 java.text 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: AttributedCharacterIterator.Attribute , TextAttribute , AttributedString , Annotation Nested Class Summary Nested Classes Modifier and Type Interface Description static class AttributedCharacterIterator.Attribute Defines attribute keys that are used to identify text attributes.

Field Summary Fields inherited from interface java.text. CharacterIterator DONE Method Summary All Methods Instance Methods Abstract Methods 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 inherited from interface java.text. CharacterIterator clone , current , first , getBeginIndex , getEndIndex , getIndex , last , next , previous , setIndex Method Detail 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 Skip navigation links Overview Package Class Use Tree Deprecated Index Help Java™ Platform Standard Ed.

8 Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method 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, 2026, Oracle and/or its affiliates.

All rights reserved. Use is subject to license terms . Also see the documentation redistribution policy .