# AttributedCharacterIterator

public interface **AttributedCharacterIterator** implements [CharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html) 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getRunStart()` and `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html` and its
subclasses, such as `https://developers.google.com/j2objc/javadoc/jre/reference/java/awt/font/TextAttribute.html`.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/awt/font/TextAttribute.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Annotation.html`

### Nested Class Summary

|---|---|---|---|
| class | [AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) || Defines attribute keys that are used to identify text attributes. |

### Inherited Constant Summary

From interface [java.text.CharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html)

|---|---|---|
| char | [DONE](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#DONE) | Constant that is returned when the iterator has reached either the end or the beginning of the text. |

### Public Method Summary

|---|---|
| abstract [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<[AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html)\> | [getAllAttributeKeys](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getAllAttributeKeys())() Returns the keys of all attributes defined on the iterator's text range. |
| abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [getAttribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getAttribute(java.text.AttributedCharacterIterator.Attribute))([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attribute) Returns the value of the named `attribute` for the current character. |
| abstract [Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<[AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html), [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)\> | [getAttributes](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getAttributes())() Returns a map with the attributes defined on the current character. |
| abstract int | [getRunLimit](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getRunLimit())() Returns the index of the first character following the run with respect to all attributes containing the current character. |
| abstract int | [getRunLimit](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getRunLimit(java.text.AttributedCharacterIterator.Attribute))([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attribute) Returns the index of the first character following the run with respect to the given `attribute` containing the current character. |
| abstract int | [getRunLimit](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getRunLimit(java.util.Set<?%20extends%20java.text.AttributedCharacterIterator.Attribute>))([Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<? extends [AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html)\> attributes) Returns the index of the first character following the run with respect to the given `attributes` containing the current character. |
| abstract int | [getRunStart](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getRunStart(java.text.AttributedCharacterIterator.Attribute))([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attribute) Returns the index of the first character of the run with respect to the given `attribute` containing the current character. |
| abstract int | [getRunStart](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getRunStart(java.util.Set<?%20extends%20java.text.AttributedCharacterIterator.Attribute>))([Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<? extends [AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html)\> attributes) Returns the index of the first character of the run with respect to the given `attributes` containing the current character. |
| abstract int | [getRunStart](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html#getRunStart())() Returns the index of the first character of the run with respect to all attributes containing the current character. |

### Inherited Method Summary

From interface [java.text.CharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html)

|---|---|
| abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#clone())() Create a copy of this iterator |
| abstract char | [current](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#current())() Gets the character at the current position (as returned by getIndex()). |
| abstract char | [first](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#first())() Sets the position to getBeginIndex() and returns the character at that position. |
| abstract int | [getBeginIndex](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#getBeginIndex())() Returns the start index of the text. |
| abstract int | [getEndIndex](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#getEndIndex())() Returns the end index of the text. |
| abstract int | [getIndex](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#getIndex())() Returns the current index. |
| abstract char | [last](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#last())() Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position. |
| abstract char | [next](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#next())() Increments the iterator's index by one and returns the character at the new index. |
| abstract char | [previous](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#previous())() Decrements the iterator's index by one and returns the character at the new index. |
| abstract char | [setIndex](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/CharacterIterator.html#setIndex(int))(int position) Sets the position to the specified position in the text and returns that character. |

## Public Methods

#### public abstract [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<[AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html)\>
**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

#### public abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)
**getAttribute**
([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) 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`

#### public abstract [Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<[AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html), [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)\>
**getAttributes**
()

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

##### Returns

- a map with the attributes defined on the current character

#### public abstract 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

#### public abstract int
**getRunLimit**
([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) 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

#### public abstract int
**getRunLimit**
([Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<? extends [AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html)\> 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

#### public abstract int
**getRunStart**
([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) 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

#### public abstract int
**getRunStart**
([Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<? extends [AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html)\> 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

#### public abstract 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