Interface AttributedCharacterIterator
- All Superinterfaces:
CharacterIterator
,Cloneable
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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
Defines attribute keys that are used to identify text attributes. -
Field Summary
Fields declared in interface java.text.CharacterIterator
DONE
-
Method Summary
Modifier and TypeMethodDescriptionReturns the keys of all attributes defined on the iterator's text range.Returns the value of the namedattribute
for the current character.Returns a map with the attributes defined on the current character.int
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 givenattribute
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 givenattributes
containing the current character.int
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 givenattribute
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 givenattributes
containing the current character.Methods declared in interface java.text.CharacterIterator
clone, current, first, getBeginIndex, getEndIndex, getIndex, last, next, previous, setIndex
-
Method Details
-
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
Returns the index of the first character of the run with respect to the givenattribute
containing the current character.- Parameters:
attribute
- the desired attribute.- Returns:
- the index of the first character of the run
-
getRunStart
Returns the index of the first character of the run with respect to the givenattributes
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
Returns the index of the first character following the run with respect to the givenattribute
containing the current character.- Parameters:
attribute
- the desired attribute- Returns:
- the index of the first character following the run
-
getRunLimit
Returns the index of the first character following the run with respect to the givenattributes
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
Returns the value of the namedattribute
for the current character. Returnsnull
if theattribute
is not defined.- Parameters:
attribute
- the desired attribute- Returns:
- the value of the named
attribute
ornull
-
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
-