# AttributedString

public class **AttributedString** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
An AttributedString holds text and related attribute information. It
may be used as the actual data storage in some cases where a text
reader wants to access attributed text through the AttributedCharacterIterator
interface.


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.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Annotation.html`

### Public Constructor Summary

|---|---|
|   | [AttributedString](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#AttributedString(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) text) Constructs an AttributedString instance with the given text. |
|   | [AttributedString](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#AttributedString(java.lang.String,%20java.util.Map<?%20extends%20java.text.AttributedCharacterIterator.Attribute,%20?>))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) text, [Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<? extends [AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html), ?\> attributes) Constructs an AttributedString instance with the given text and attributes. |
|   | [AttributedString](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#AttributedString(java.text.AttributedCharacterIterator))([AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) text) Constructs an AttributedString instance with the given attributed text represented by AttributedCharacterIterator. |
|   | [AttributedString](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#AttributedString(java.text.AttributedCharacterIterator,%20int,%20int))([AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) text, int beginIndex, int endIndex) Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator. |
|   | [AttributedString](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#AttributedString(java.text.AttributedCharacterIterator,%20int,%20int,%20java.text.AttributedCharacterIterator.Attribute[]))([AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) text, int beginIndex, int endIndex, [Attribute\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attributes) Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator. |

### Public Method Summary

|---|---|
| void | [addAttribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#addAttribute(java.text.AttributedCharacterIterator.Attribute,%20java.lang.Object))([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attribute, [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value) Adds an attribute to the entire string. |
| void | [addAttribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#addAttribute(java.text.AttributedCharacterIterator.Attribute,%20java.lang.Object,%20int,%20int))([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attribute, [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value, int beginIndex, int endIndex) Adds an attribute to a subrange of the string. |
| void | [addAttributes](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#addAttributes(java.util.Map<?%20extends%20java.text.AttributedCharacterIterator.Attribute,%20?>,%20int,%20int))([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<? extends [AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html), ?\> attributes, int beginIndex, int endIndex) Adds a set of attributes to a subrange of the string. |
| [AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) | [getIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#getIterator())() Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string. |
| [AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) | [getIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#getIterator(java.text.AttributedCharacterIterator.Attribute[]))([Attribute\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attributes) Creates an AttributedCharacterIterator instance that provides access to selected contents of this string. |
| [AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) | [getIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedString.html#getIterator(java.text.AttributedCharacterIterator.Attribute[],%20int,%20int))([Attribute\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attributes, int beginIndex, int endIndex) Creates an AttributedCharacterIterator instance that provides access to selected contents of this string. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Public Constructors

#### public
**AttributedString**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) text)

Constructs an AttributedString instance with the given text.

##### Parameters

| text | The text for this attributed string. |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `text` is null. |
|---|---|

#### public
**AttributedString**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) text, [Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<? extends [AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html), ?\> attributes)

Constructs an AttributedString instance with the given text and attributes.

##### Parameters

| text | The text for this attributed string. |
| attributes | The attributes that apply to the entire string. |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `text` or `attributes` is null. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the text has length 0 and the attributes parameter is not an empty Map (attributes cannot be applied to a 0-length range). |
|---|---|

#### public
**AttributedString**
([AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) text)

Constructs an AttributedString instance with the given attributed
text represented by AttributedCharacterIterator.

##### Parameters

| text | The text for this attributed string. |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `text` is null. |
|---|---|

#### public
**AttributedString**
([AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) text, int beginIndex, int endIndex)

Constructs an AttributedString instance with the subrange of
the given attributed text represented by
AttributedCharacterIterator. If the given range produces an
empty text, all attributes will be discarded. Note that any
attributes wrapped by an Annotation object are discarded for a
subrange of the original attribute range.

##### Parameters

| text | The text for this attributed string. |
| beginIndex | Index of the first character of the range. |
| endIndex | Index of the character following the last character of the range. |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `text` is null. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the subrange given by beginIndex and endIndex is out of the text range. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Annotation.html`

#### public
**AttributedString**
([AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) text, int beginIndex, int endIndex, [Attribute\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attributes)

Constructs an AttributedString instance with the subrange of
the given attributed text represented by
AttributedCharacterIterator. Only attributes that match the
given attributes will be incorporated into the instance. If the
given range produces an empty text, all attributes will be
discarded. Note that any attributes wrapped by an Annotation
object are discarded for a subrange of the original attribute
range.

##### Parameters

| text | The text for this attributed string. |
| beginIndex | Index of the first character of the range. |
| endIndex | Index of the character following the last character of the range. |
| attributes | Specifies attributes to be extracted from the text. If null is specified, all available attributes will be used. |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `text` is null. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the subrange given by beginIndex and endIndex is out of the text range. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Annotation.html`

## Public Methods

#### public void
**addAttribute**
([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attribute, [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value)

Adds an attribute to the entire string.

##### Parameters

| attribute | the attribute key |
| value | the value of the attribute; may be null |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `attribute` is null. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the AttributedString has length 0 (attributes cannot be applied to a 0-length range). |
|---|---|

#### public void
**addAttribute**
([AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attribute, [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value, int beginIndex, int endIndex)

Adds an attribute to a subrange of the string.

##### Parameters

| attribute | the attribute key |
| value | The value of the attribute. May be null. |
| beginIndex | Index of the first character of the range. |
| endIndex | Index of the character following the last character of the range. |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `attribute` is null. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string. |
|---|---|

#### public void
**addAttributes**
([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<? extends [AttributedCharacterIterator.Attribute](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html), ?\> attributes, int beginIndex, int endIndex)

Adds a set of attributes to a subrange of the string.

##### Parameters

| attributes | The attributes to be added to the string. |
| beginIndex | Index of the first character of the range. |
| endIndex | Index of the character following the last character of the range. |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `attributes` is null. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string and the attributes parameter is not an empty Map. |
|---|---|

#### public [AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html)
**getIterator**
()

Creates an AttributedCharacterIterator instance that provides access to the entire contents of
this string.

##### Returns

- An iterator providing access to the text and its attributes.

#### public [AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html)
**getIterator**
([Attribute\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attributes)

Creates an AttributedCharacterIterator instance that provides access to
selected contents of this string.
Information about attributes not listed in attributes that the
implementor may have need not be made accessible through the iterator.
If the list is null, all available attribute information should be made
accessible.

##### Parameters

| attributes | a list of attributes that the client is interested in |
|---|---|

##### Returns

- an iterator providing access to the entire text and its selected attributes

#### public [AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html)
**getIterator**
([Attribute\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.Attribute.html) attributes, int beginIndex, int endIndex)

Creates an AttributedCharacterIterator instance that provides access to
selected contents of this string.
Information about attributes not listed in attributes that the
implementor may have need not be made accessible through the iterator.
If the list is null, all available attribute information should be made
accessible.

##### Parameters

| attributes | a list of attributes that the client is interested in |
| beginIndex | the index of the first character |
| endIndex | the index of the character following the last character |
|---|---|

##### Returns

- an iterator providing access to the text and its attributes

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex is greater than endIndex. |
|---|---|