# TtsSpan.Builder

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

# TtsSpan.Builder

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.Builder "View this page in Kotlin")\|Java

`
public
static


class
TtsSpan.Builder
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object)                                                                                            ||
| ↳ | android.text.style.TtsSpan.Builder\<C extends[android.text.style.TtsSpan.Builder](https://developer.android.com/reference/android/text/style/TtsSpan.Builder)\<?\>\> |

|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Known direct subclasses [TtsSpan.SemioticClassBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.SemioticClassBuilder)\<C extends[SemioticClassBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.SemioticClassBuilder)\<?\>\> |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| | [TtsSpan.SemioticClassBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.SemioticClassBuilder)\<C extends[SemioticClassBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.SemioticClassBuilder)\<?\>\> | A builder for TtsSpans, has setters for morphosyntactic features. | |

|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Known indirect subclasses [TtsSpan.CardinalBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.CardinalBuilder),[TtsSpan.DateBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.DateBuilder),[TtsSpan.DecimalBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.DecimalBuilder),[TtsSpan.DigitsBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.DigitsBuilder),[TtsSpan.DurationBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.DurationBuilder),[TtsSpan.ElectronicBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.ElectronicBuilder),[TtsSpan.FractionBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.FractionBuilder),[TtsSpan.MeasureBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.MeasureBuilder),[TtsSpan.MoneyBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.MoneyBuilder),[TtsSpan.OrdinalBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.OrdinalBuilder),[TtsSpan.TelephoneBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.TelephoneBuilder),[TtsSpan.TextBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.TextBuilder),[TtsSpan.TimeBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.TimeBuilder),[TtsSpan.VerbatimBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.VerbatimBuilder) |-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| | [TtsSpan.CardinalBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.CardinalBuilder)     | A builder for TtsSpans of type[TtsSpan.TYPE_CARDINAL](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_CARDINAL).     | | [TtsSpan.DateBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.DateBuilder)             | A builder for TtsSpans of type[TtsSpan.TYPE_DATE](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DATE).             | | [TtsSpan.DecimalBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.DecimalBuilder)       | A builder for TtsSpans of type[TtsSpan.TYPE_DECIMAL](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DECIMAL).       | | [TtsSpan.DigitsBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.DigitsBuilder)         | A builder for TtsSpans of type[TtsSpan.TYPE_DIGITS](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DIGITS).         | | [TtsSpan.DurationBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.DurationBuilder)     | A builder for TtsSpans of type[TtsSpan.TYPE_DURATION](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DURATION).     | | [TtsSpan.ElectronicBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.ElectronicBuilder) | A builder for TtsSpans of type[TtsSpan.TYPE_ELECTRONIC](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC). | | [TtsSpan.FractionBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.FractionBuilder)     | A builder for TtsSpans of type[TtsSpan.TYPE_FRACTION](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_FRACTION).     | | [TtsSpan.MeasureBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.MeasureBuilder)       | A builder for TtsSpans of type[TtsSpan.TYPE_MEASURE](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_MEASURE).       | | [TtsSpan.MoneyBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.MoneyBuilder)           | A builder for TtsSpans of type[TtsSpan.TYPE_MONEY](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_MONEY).           | | [TtsSpan.OrdinalBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.OrdinalBuilder)       | A builder for TtsSpans of type[TtsSpan.TYPE_ORDINAL](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ORDINAL).       | | [TtsSpan.TelephoneBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.TelephoneBuilder)   | A builder for TtsSpans of type[TtsSpan.TYPE_TELEPHONE](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TELEPHONE).   | | [TtsSpan.TextBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.TextBuilder)             | A builder for TtsSpans of type[TtsSpan.TYPE_TEXT](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TEXT).             | | [TtsSpan.TimeBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.TimeBuilder)             | A builder for TtsSpans of type[TtsSpan.TYPE_TIME](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME).             | | [TtsSpan.VerbatimBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.VerbatimBuilder)     | A builder for TtsSpans of type[TtsSpan.TYPE_VERBATIM](https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_VERBATIM).     | |

<br />

*** ** * ** ***

A simple builder for TtsSpans. This builder can be used directly, but the more specific subclasses of this builder like[TtsSpan.TextBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.TextBuilder)and[TtsSpan.CardinalBuilder](https://developer.android.com/reference/android/text/style/TtsSpan.CardinalBuilder)are likely more useful. This class uses generics so methods from this class can return instances of its child classes, resulting in a fluent API (CRTP pattern).

## Summary

|                                                                                       ### Public constructors                                                                                       ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[Builder](https://developer.android.com/reference/android/text/style/TtsSpan.Builder#Builder(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` type) ` |

|                                                                                                                                                                                                            ### Public methods                                                                                                                                                                                                             ||
|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` `[TtsSpan](https://developer.android.com/reference/android/text/style/TtsSpan) | ` `[build](https://developer.android.com/reference/android/text/style/TtsSpan.Builder#build())`() ` Returns a TtsSpan built from the parameters set by the setter methods.                                                                                                                                                                              |
| ` C`                                                                             | ` `[setIntArgument](https://developer.android.com/reference/android/text/style/TtsSpan.Builder#setIntArgument(java.lang.String,%20int))`(`[String](https://developer.android.com/reference/java/lang/String)` arg, int value) ` Sets an argument to an int value.                                                                                       |
| ` C`                                                                             | ` `[setLongArgument](https://developer.android.com/reference/android/text/style/TtsSpan.Builder#setLongArgument(java.lang.String,%20long))`(`[String](https://developer.android.com/reference/java/lang/String)` arg, long value) ` Sets an argument to a long value.                                                                                   |
| ` C`                                                                             | ` `[setStringArgument](https://developer.android.com/reference/android/text/style/TtsSpan.Builder#setStringArgument(java.lang.String,%20java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` arg, `[String](https://developer.android.com/reference/java/lang/String)` value) ` Sets an argument to a string value. |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](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 `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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*.                                                                                             | ||

## Public constructors

### Builder

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

```
public Builder (String type)
```

<br />

<br />

|       Parameters        ||
|--------|-----------------|
| `type` | `String` <br /> |

## Public methods

### build

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

```
public TtsSpan build ()
```

Returns a TtsSpan built from the parameters set by the setter methods.

<br />

|                                                                Returns                                                                 ||
|-------------------------------------------------------------------------------|---------------------------------------------------------|
| [TtsSpan](https://developer.android.com/reference/android/text/style/TtsSpan) | A TtsSpan built with parameters of this builder. <br /> |

### setIntArgument

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

```
public C setIntArgument (String arg, 
                int value)
```

Sets an argument to an int value.

<br />

|                           Parameters                            ||
|---------|--------------------------------------------------------|
| `arg`   | `String`: The argument name. <br />                    |
| `value` | `int`: The value the argument should be set to. <br /> |

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

### setLongArgument

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

```
public C setLongArgument (String arg, 
                long value)
```

Sets an argument to a long value.

<br />

|                            Parameters                            ||
|---------|---------------------------------------------------------|
| `arg`   | `String`: The argument name. <br />                     |
| `value` | `long`: The value the argument should be set to. <br /> |

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

### setStringArgument

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

```
public C setStringArgument (String arg, 
                String value)
```

Sets an argument to a string value.

<br />

|                             Parameters                             ||
|---------|-----------------------------------------------------------|
| `arg`   | `String`: The argument name. <br />                       |
| `value` | `String`: The value the argument should be set to. <br /> |

|          Returns           ||
|-----|-----------------------|
| `C` | This instance. <br /> |