AttributedCharacterIterator

public interface AttributedCharacterIterator implements 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

class AttributedCharacterIterator.Attribute Defines keys for text attributes. 

Inherited Constant Summary

Public Method Summary

abstract Set<AttributedCharacterIterator.Attribute>
getAllAttributeKeys()
Returns a set of attributes present in the AttributedCharacterIterator.
abstract Object
getAttribute(AttributedCharacterIterator.Attribute attribute)
Returns the value stored in the attribute for the current character.
abstract Map<AttributedCharacterIterator.AttributeObject>
getAttributes()
Returns a map of all attributes of the current character.
abstract int
getRunLimit()
Returns the index of the last character in the run having the same attributes as the current character.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract int
getRunStart()
Returns the index of the first character in the run that has the same attributes as the current character.

Inherited Method Summary

Public Methods

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

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

public abstract Map<AttributedCharacterIterator.AttributeObject> 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.

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

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

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

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

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

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