# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Nested Classes | Inherited Constants | Methods | Inherited Methods

# AttributedCharacterIterator

`public interface AttributedCharacterIterator`
`implements CharacterIterator`

java.text.AttributedCharacterIterator

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`.

See also:

- `AttributedCharacterIterator.Attribute`
- `TextAttribute`
- `AttributedString`
- `Annotation`

## Summary

### Nested classes
`class` | `AttributedCharacterIterator.Attribute` Defines attribute keys that are used to identify text attributes.

### Inherited constants
From interface `java.text.CharacterIterator`
`char` | `DONE` Constant that is returned when the iterator has reached either the end or the beginning of the text.

### Public methods
`abstract Set<AttributedCharacterIterator.Attribute>` | `getAllAttributeKeys()` Returns the keys of all attributes defined on the iterator's text range.
`abstract Object` | `getAttribute(AttributedCharacterIterator.Attribute attribute)` Returns the value of the named `attribute` for the current character.
`abstract Map<AttributedCharacterIterator.Attribute, Object>` | `getAttributes()` Returns a map with the attributes defined on the current character.
`abstract int` | `getRunLimit()` Returns the index of the first character following the run with respect to all attributes containing the current character.
`abstract 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.
`abstract 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.
`abstract 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.
`abstract 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.
`abstract int` | `getRunStart()` Returns the index of the first character of the run with respect to all attributes containing the current character.

### Inherited methods
From interface `java.text.CharacterIterator`
`abstract Object` | `clone()` Create a copy of this iterator
`abstract char` | `current()` Gets the character at the current position (as returned by getIndex()).
`abstract char` | `first()` Sets the position to getBeginIndex() and returns the character at that position.
`abstract int` | `getBeginIndex()` Returns the start index of the text.
`abstract int` | `getEndIndex()` Returns the end index of the text.
`abstract int` | `getIndex()` Returns the current index.
`abstract char` | `last()` Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
`abstract char` | `next()` Increments the iterator's index by one and returns the character at the new index.
`abstract char` | `previous()` Decrements the iterator's index by one and returns the character at the new index.
`abstract char` | `setIndex(int position)` Sets the position to the specified position in the text and returns that character.

## Public methods

### getAllAttributeKeys

    public abstract 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
`Set<AttributedCharacterIterator.Attribute>` | the keys of all attributes

### getAttribute

    public abstract 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` | `AttributedCharacterIterator.Attribute`: the desired attribute

Returns
`Object` | the value of the named `attribute` or `null`

### getAttributes

    public abstract Map<AttributedCharacterIterator.Attribute, Object> getAttributes ()

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

Returns
`Map<AttributedCharacterIterator.Attribute, Object>` | a map with the attributes defined on the current character

### getRunLimit

    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
`int` | the index of the first character following the run

### getRunLimit

    public abstract 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` | `AttributedCharacterIterator.Attribute`: the desired attribute

Returns
`int` | the index of the first character following the run

### getRunLimit

    public abstract 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` | `Set`: a set of the desired attributes

Returns
`int` | the index of the first character following the run

### getRunStart

    public abstract 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` | `AttributedCharacterIterator.Attribute`: the desired attribute.

Returns
`int` | the index of the first character of the run

### getRunStart

    public abstract 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` | `Set`: a set of the desired attributes.

Returns
`int` | the index of the first character of the run

### getRunStart

    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
`int` | the index of the first character of the run

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*