Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Inherited Constants](https://developer.android.com/reference/android/text/SpannedString#inhconstants) \| [Ctors](https://developer.android.com/reference/android/text/SpannedString#pubctors) \| [Methods](https://developer.android.com/reference/android/text/SpannedString#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/text/SpannedString#inhmethods)

# SpannedString

*** ** * ** ***


`
public

final

class
SpannedString
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/java/lang/CharSequence,

https://developer.android.com/reference/android/text/GetChars,

https://developer.android.com/reference/android/text/Spanned


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.text.SpannedString |

<br />

*** ** * ** ***

This is the class for text whose content and markup are immutable.
For mutable markup, see `https://developer.android.com/reference/android/text/SpannableString`; for mutable text,
see `https://developer.android.com/reference/android/text/SpannableStringBuilder`.

## Summary

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/text/Spanned` |---|---| | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_COMPOSING` This flag is set on spans that are being used to apply temporary styling information on the composing text of an input method, so that they can be found and removed when the composing text is being replaced. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_EXCLUSIVE_EXCLUSIVE` Spans of type SPAN_EXCLUSIVE_EXCLUSIVE do not expand to include text inserted at either their starting or ending point. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_EXCLUSIVE_INCLUSIVE` Non-0-length spans of type SPAN_EXCLUSIVE_INCLUSIVE expand to include text inserted at their ending point but not at their starting point. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_INCLUSIVE_EXCLUSIVE` Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their starting point but not at their ending point. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_INCLUSIVE_INCLUSIVE` Spans of type SPAN_INCLUSIVE_INCLUSIVE expand to include text inserted at either their starting or ending point. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_INTERMEDIATE` This flag will be set for intermediate span changes, meaning there is guaranteed to be another change following it. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_MARK_MARK` 0-length spans with type SPAN_MARK_MARK behave like text marks: they remain at their original offset when text is inserted at that offset. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_MARK_POINT` SPAN_MARK_POINT is a synonym for `https://developer.android.com/reference/android/text/Spanned#SPAN_INCLUSIVE_INCLUSIVE`. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_PARAGRAPH` SPAN_PARAGRAPH behaves like SPAN_INCLUSIVE_EXCLUSIVE (SPAN_MARK_MARK), except that if either end of the span is at the end of the buffer, that end behaves like _POINT instead (so SPAN_INCLUSIVE_INCLUSIVE if it starts in the middle and ends at the end, or SPAN_EXCLUSIVE_INCLUSIVE if it both starts and ends at the end). | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_POINT_MARK` SPAN_POINT_MARK is a synonym for `https://developer.android.com/reference/android/text/Spanned#SPAN_EXCLUSIVE_EXCLUSIVE`. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_POINT_MARK_MASK` Bitmask of bits that are relevent for controlling point/mark behavior of spans. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_POINT_POINT` 0-length spans with type SPAN_POINT_POINT behave like cursors: they are pushed forward by the length of the insertion when text is inserted at their offset. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_PRIORITY` The bits specified by the SPAN_PRIORITY bitmap determine the order of change notifications -- higher numbers go first. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_PRIORITY_SHIFT` The bits numbered just above SPAN_PRIORITY_SHIFT determine the order of change notifications -- higher numbers go first. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_USER` The bits specified by the SPAN_USER bitfield are available for callers to use to store scalar data associated with their span object. | | `int` | `https://developer.android.com/reference/android/text/Spanned#SPAN_USER_SHIFT` The bits numbered SPAN_USER_SHIFT and above are available for callers to use to store scalar data associated with their span object. | |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/text/SpannedString#SpannedString(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence source) ` For the backward compatibility reasons, this constructor copies all spans including `https://developer.android.com/reference/android/text/NoCopySpan`. |

| ### Public methods ||
|---|---|
| ` char` | ` https://developer.android.com/reference/android/text/SpannedString#charAt(int)(int i) ` Returns the `char` value at the specified index. |
| ` boolean` | ` https://developer.android.com/reference/android/text/SpannedString#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` void` | ` https://developer.android.com/reference/android/text/SpannedString#getChars(int,%20int,%20char[],%20int)(int start, int end, char[] dest, int off) ` Exactly like String.getChars(): copy chars `start` through `end - 1` from this CharSequence into `dest` beginning at offset `destoff`. |
| ` int` | ` https://developer.android.com/reference/android/text/SpannedString#getSpanEnd(java.lang.Object)(https://developer.android.com/reference/java/lang/Object what) ` Return the end of the range of text to which the specified markup object is attached, or -1 if the object is not attached. |
| ` int` | ` https://developer.android.com/reference/android/text/SpannedString#getSpanFlags(java.lang.Object)(https://developer.android.com/reference/java/lang/Object what) ` Return the flags that were specified when `https://developer.android.com/reference/android/text/Spannable#setSpan(java.lang.Object,%20int,%20int,%20int)` was used to attach the specified markup object, or 0 if the specified object has not been attached. |
| ` int` | ` https://developer.android.com/reference/android/text/SpannedString#getSpanStart(java.lang.Object)(https://developer.android.com/reference/java/lang/Object what) ` Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached. |
| ` <T> T[]` | ` https://developer.android.com/reference/android/text/SpannedString#getSpans(int,%20int,%20java.lang.Class<T>)(int queryStart, int queryEnd, https://developer.android.com/reference/java/lang/Class<T> kind) ` Return an array of the markup objects attached to the specified slice of this CharSequence and whose type is the specified type or a subclass of it. |
| ` int` | ` https://developer.android.com/reference/android/text/SpannedString#hashCode()() ` Returns a hash code value for the object. |
| ` int` | ` https://developer.android.com/reference/android/text/SpannedString#length()() ` Returns the length of this character sequence. |
| ` int` | ` https://developer.android.com/reference/android/text/SpannedString#nextSpanTransition(int,%20int,%20java.lang.Class)(int start, int limit, https://developer.android.com/reference/java/lang/Class<T> kind) ` Return the first offset greater than `start` where a markup object of class `type` begins or ends, or `limit` if there are no starts or ends greater than `start` but less than `limit`. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/text/SpannedString#subSequence(int,%20int)(int start, int end) ` Returns a `CharSequence` that is a subsequence of this sequence. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/text/SpannedString#toString()() ` Returns a string representation of the object. |
| ` static https://developer.android.com/reference/android/text/SpannedString` | ` https://developer.android.com/reference/android/text/SpannedString#valueOf(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence source) ` |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/java/lang/CharSequence ` |---|---| | ` abstract char` | ` https://developer.android.com/reference/java/lang/CharSequence#charAt(int)(int index) ` Returns the `char` value at the specified index. | | ` default https://developer.android.com/reference/java/util/stream/IntStream` | ` https://developer.android.com/reference/java/lang/CharSequence#chars()() ` Returns a stream of `int` zero-extending the `char` values from this sequence. | | ` default https://developer.android.com/reference/java/util/stream/IntStream` | ` https://developer.android.com/reference/java/lang/CharSequence#codePoints()() ` Returns a stream of code point values from this sequence. | | ` static int` | ` https://developer.android.com/reference/java/lang/CharSequence#compare(java.lang.CharSequence,%20java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence cs1, https://developer.android.com/reference/java/lang/CharSequence cs2) ` Compares two `CharSequence` instances lexicographically. | | ` default void` | ` https://developer.android.com/reference/java/lang/CharSequence#getChars(int,%20int,%20char[],%20int)(int srcBegin, int srcEnd, char[] dst, int dstBegin) ` Copies characters from this sequence into the given destination array. | | ` default boolean` | ` https://developer.android.com/reference/java/lang/CharSequence#isEmpty()() ` Returns `true` if this character sequence is empty. | | ` abstract int` | ` https://developer.android.com/reference/java/lang/CharSequence#length()() ` Returns the length of this character sequence. | | ` abstract https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/java/lang/CharSequence#subSequence(int,%20int)(int start, int end) ` Returns a `CharSequence` that is a subsequence of this sequence. | | ` abstract https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/CharSequence#toString()() ` Returns a string containing the characters in this sequence in the same order as this sequence. | ||
| From interface ` https://developer.android.com/reference/android/text/GetChars ` |---|---| | ` abstract void` | ` https://developer.android.com/reference/android/text/GetChars#getChars(int,%20int,%20char[],%20int)(int start, int end, char[] dest, int destoff) ` Exactly like String.getChars(): copy chars `start` through `end - 1` from this CharSequence into `dest` beginning at offset `destoff`. | ||
| From interface ` https://developer.android.com/reference/android/text/Spanned ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/text/Spanned#getSpanEnd(java.lang.Object)(https://developer.android.com/reference/java/lang/Object tag) ` Return the end of the range of text to which the specified markup object is attached, or -1 if the object is not attached. | | ` abstract int` | ` https://developer.android.com/reference/android/text/Spanned#getSpanFlags(java.lang.Object)(https://developer.android.com/reference/java/lang/Object tag) ` Return the flags that were specified when `https://developer.android.com/reference/android/text/Spannable#setSpan(java.lang.Object,%20int,%20int,%20int)` was used to attach the specified markup object, or 0 if the specified object has not been attached. | | ` abstract int` | ` https://developer.android.com/reference/android/text/Spanned#getSpanStart(java.lang.Object)(https://developer.android.com/reference/java/lang/Object tag) ` Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached. | | ` abstract <T> T[]` | ` https://developer.android.com/reference/android/text/Spanned#getSpans(int,%20int,%20java.lang.Class<T>)(int start, int end, https://developer.android.com/reference/java/lang/Class<T> type) ` Return an array of the markup objects attached to the specified slice of this CharSequence and whose type is the specified type or a subclass of it. | | ` abstract int` | ` https://developer.android.com/reference/android/text/Spanned#nextSpanTransition(int,%20int,%20java.lang.Class)(int start, int limit, https://developer.android.com/reference/java/lang/Class<T> type) ` Return the first offset greater than `start` where a markup object of class `type` begins or ends, or `limit` if there are no starts or ends greater than `start` but less than `limit`. | ||

## Public constructors

### SpannedString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public SpannedString (CharSequence source)
```

For the backward compatibility reasons, this constructor copies all spans including `https://developer.android.com/reference/android/text/NoCopySpan`.

<br />

| Parameters ||
|---|---|
| `source` | `CharSequence`: source text <br /> |

## Public methods

### charAt

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public char charAt (int i)
```

Returns the `char` value at the specified index. An index ranges from zero
to `length() - 1`. The first `char` value of the sequence is at
index zero, the next at index one, and so on, as for array
indexing.

If the `char` value specified by the index is a
[surrogate](https://reference/java/lang/Character.html#unicode), the surrogate
value is returned.

<br />

| Parameters ||
|---|---|
| `i` | `int`: the index of the `char` value to be returned <br /> |

| Returns ||
|---|---|
| `char` | the specified `char` value <br /> |

### equals

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object o)
```

Indicates whether some other object is "equal to" this one.


The `equals` method implements an equivalence relation
on non-null object references:

- It is *reflexive*: for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.


An equivalence relation partitions the elements it operates on
into *equivalence classes*; all the members of an
equivalence class are equal to each other. Members of an
equivalence class are substitutable for each other, at least
for some purposes.

<br />

| Parameters ||
|---|---|
| `o` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getChars

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void getChars (int start, 
                int end, 
                char[] dest, 
                int off)
```

Exactly like String.getChars(): copy chars `start`
through `end - 1` from this CharSequence into `dest`
beginning at offset `destoff`.

<br />

| Parameters ||
|---|---|
| `start` | `int`: start copying at this offset. <br /> |
| `end` | `int`: stop copying at this offset. <br /> |
| `dest` | `char`: the array to copy the data into. <br /> |
| `off` | `int`: offset into `dst`. <br /> |

### getSpanEnd

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSpanEnd (Object what)
```

Return the end of the range of text to which the specified
markup object is attached, or -1 if the object is not attached.

<br />

| Parameters ||
|---|---|
| `what` | `Object` <br /> |

| Returns ||
|---|---|
| `int` | <br /> |

### getSpanFlags

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSpanFlags (Object what)
```

Return the flags that were specified when `https://developer.android.com/reference/android/text/Spannable#setSpan(java.lang.Object,%20int,%20int,%20int)` was
used to attach the specified markup object, or 0 if the specified
object has not been attached.

<br />

| Parameters ||
|---|---|
| `what` | `Object` <br /> |

| Returns ||
|---|---|
| `int` | <br /> |

### getSpanStart

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSpanStart (Object what)
```

Return the beginning of the range of text to which the specified
markup object is attached, or -1 if the object is not attached.

<br />

| Parameters ||
|---|---|
| `what` | `Object` <br /> |

| Returns ||
|---|---|
| `int` | <br /> |

### getSpans

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public T[] getSpans (int queryStart, 
                int queryEnd, 
                Class<T> kind)
```

Return an array of the markup objects attached to the specified
slice of this CharSequence and whose type is the specified type
or a subclass of it. Specify Object.class for the type if you
want all the objects regardless of type.

<br />

| Parameters ||
|---|---|
| `queryStart` | `int` <br /> |
| `queryEnd` | `int` <br /> |
| `kind` | `Class` <br /> |

| Returns ||
|---|---|
| `T[]` | <br /> |

### hashCode

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
`https://developer.android.com/reference/java/util/HashMap`.


The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### length

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int length ()
```

Returns the length of this character sequence. The length is the number
of 16-bit `char`s in the sequence.

<br />

| Returns ||
|---|---|
| `int` | the number of `char`s in this sequence <br /> |

### nextSpanTransition

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int nextSpanTransition (int start, 
                int limit, 
                Class<T> kind)
```

Return the first offset greater than `start` where a markup
object of class `type` begins or ends, or `limit`
if there are no starts or ends greater than `start` but less
than `limit`. Specify `null` or Object.class for
the type if you want every transition regardless of type.

<br />

| Parameters ||
|---|---|
| `start` | `int` <br /> |
| `limit` | `int` <br /> |
| `kind` | `Class` <br /> |

| Returns ||
|---|---|
| `int` | <br /> |

### subSequence

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence subSequence (int start, 
                int end)
```

Returns a `CharSequence` that is a subsequence of this sequence.
The subsequence starts with the `char` value at the specified index and
ends with the `char` value at index `end - 1`. The length
(in `char`s) of the
returned sequence is `end - start`, so if `start == end`
then an empty sequence is returned.

<br />

| Parameters ||
|---|---|
| `start` | `int`: the start index, inclusive <br /> |
| `end` | `int`: the end index, exclusive <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | the specified subsequence <br /> |

### toString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static SpannedString valueOf (CharSequence source)
```

<br />

<br />

| Parameters ||
|---|---|
| `source` | `CharSequence` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/text/SpannedString` | <br /> |