java.text

Interface AttributedCharacterIterator

All Superinterfaces:

CharacterIterator, Cloneable

public interface AttributedCharacterIterator
extends CharacterIterator

Extends the CharacterIterator interface, adding support for iterating over attributes and not only characters. An AttributedCharacterIterator also allows the user to find runs and their limits. Runs are defined as ranges of characters that all have the same attributes with the same values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AttributedCharacterIterator.Attribute Defines keys for text attributes.

Field Summary

Fields inherited from interface java.text.CharacterIterator

DONE

Method Summary

Modifier and Type	Method and Description
Set<AttributedCharacterIterator.Attribute>	getAllAttributeKeys() Returns a set of attributes present in the AttributedCharacterIterator.
Object	getAttribute(AttributedCharacterIterator.Attribute attribute) Returns the value stored in the attribute for the current character.
Map<AttributedCharacterIterator.Attribute,Object>	getAttributes() Returns a map of all attributes of the current character.
int	getRunLimit() Returns the index of the last character in the run having the same attributes as the current character.
int	getRunLimit(AttributedCharacterIterator.Attribute attribute) Returns the index of the last character in the run that has the same attribute value for the given attribute as the current character.
int	getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes) Returns the index of the last character in the run that has the same attribute values for the attributes in the set as the current character.
int	getRunStart() Returns the index of the first character in the run that has the same attributes as the current character.
int	getRunStart(AttributedCharacterIterator.Attribute attribute) Returns the index of the first character in the run that has the same attribute value for the given attribute as the current character.
int	getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes) Returns the index of the first character in the run that has the same attribute values for the attributes in the set as the current character.

Methods inherited from interface java.text.CharacterIterator

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

Method Detail

getAllAttributeKeys

Set<AttributedCharacterIterator.Attribute> getAllAttributeKeys()

Returns a set of attributes present in the AttributedCharacterIterator. An empty set is returned if no attributes were defined.

Returns:

a set of attribute keys; may be empty.

getAttribute

Object getAttribute(AttributedCharacterIterator.Attribute attribute)

Returns the value stored in the attribute for the current character. If the attribute was not defined then null is returned.

Parameters:

attribute - the attribute for which the value should be returned.

Returns:

the value of the requested attribute for the current character or null if it was not defined.

getAttributes

Map<AttributedCharacterIterator.Attribute,Object> getAttributes()

Returns a map of all attributes of the current character. If no attributes were defined for the current character then an empty map is returned.

Returns:

a map of all attributes for the current character or an empty map.

getRunLimit

int getRunLimit()

Returns the index of the last character in the run having the same attributes as the current character.

Returns:

the index of the last character of the current run.

getRunLimit

int getRunLimit(AttributedCharacterIterator.Attribute attribute)

Returns the index of the last character in the run that has the same attribute value for the given attribute as the current character.

Parameters:

attribute - the attribute which the run is based on.

Returns:

the index of the last character of the current run.

getRunLimit

int getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)

Returns the index of the last character in the run that has the same attribute values for the attributes in the set as the current character.

Parameters:

attributes - the set of attributes which the run is based on.

Returns:

the index of the last character of the current run.

getRunStart

int getRunStart()

Returns the index of the first character in the run that has the same attributes as the current character.

Returns:

the index of the last character of the current run.

getRunStart

int getRunStart(AttributedCharacterIterator.Attribute attribute)

Returns the index of the first character in the run that has the same attribute value for the given attribute as the current character.

Parameters:

attribute - the attribute which the run is based on.

Returns:

the index of the last character of the current run.

getRunStart

int getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)

Returns the index of the first character in the run that has the same attribute values for the attributes in the set as the current character.

Parameters:

attributes - the set of attributes which the run is based on.

Returns:

the index of the last character of the current run.