# TtsSpan.CardinalBuilder

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

# CardinalBuilder

*** ** * ** ***

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

```
open class CardinalBuilder : TtsSpan.SemioticClassBuilder<TtsSpan.CardinalBuilder!>
```

|---|---|---|------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                 ||||
| ↳ | [android.text.style.TtsSpan.Builder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.Builder)\<C\>                   |||
|   | ↳ | [android.text.style.TtsSpan.SemioticClassBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.SemioticClassBuilder)\<[android.text.style.TtsSpan.CardinalBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#)\> ||
|   |   | ↳ | [android.text.style.TtsSpan.CardinalBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#) |

A builder for TtsSpans of type[TYPE_CARDINAL](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#TYPE_CARDINAL:kotlin.String).

## Summary

|                                                                                                                                                                                                                                                         Public constructors                                                                                                                                                                                                                                                          ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [CardinalBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#CardinalBuilder())`()` Creates a builder for a TtsSpan of type[TYPE_CARDINAL](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#TYPE_CARDINAL:kotlin.String).                                                                                                                                                                                                                                 |
| [CardinalBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#CardinalBuilder(kotlin.String))`(`number:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Creates a TtsSpan of type[TYPE_CARDINAL](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#TYPE_CARDINAL:kotlin.String)and sets the[ARG_NUMBER](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#ARG_NUMBER:kotlin.String)argument. |
| [CardinalBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#CardinalBuilder(kotlin.Long))`(`number:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` Creates a TtsSpan of type[TYPE_CARDINAL](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#TYPE_CARDINAL:kotlin.String)and sets the[ARG_NUMBER](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#ARG_NUMBER:kotlin.String)argument.        |

|                                                                                                                                                                                                                                                                       Public methods                                                                                                                                                                                                                                                                       ||
|----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| open[TtsSpan.CardinalBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#)! | [setNumber](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#setNumber(kotlin.String))`(`number:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Sets the[ARG_NUMBER](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#ARG_NUMBER:kotlin.String)argument.                                                             |
| open[TtsSpan.CardinalBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#)! | [setNumber](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#setNumber(kotlin.Long))`(`number:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` Convenience method that converts the number to a String and set it to the value for[ARG_NUMBER](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#ARG_NUMBER:kotlin.String). |

| Inherited functions ||
|---|---|
| From class[Builder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.Builder) |---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [TtsSpan](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan)! | [build](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.Builder#build())`()` <br /> Returns a TtsSpan built from the parameters set by the setter methods. <br />                                                                                                                                                                                                            | | C                                                                                     | [setIntArgument](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.Builder#setIntArgument(kotlin.String,%20kotlin.Int))`(`arg:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `value:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` <br /> Sets an argument to an int value. <br />                   | | C                                                                                     | [setLongArgument](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.Builder#setLongArgument(kotlin.String,%20kotlin.Long))`(`arg:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `value:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` <br /> Sets an argument to a long value. <br />              | | C                                                                                     | [setStringArgument](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.Builder#setStringArgument(kotlin.String,%20kotlin.String))`(`arg:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `value:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` <br /> Sets an argument to a string value. <br /> | ||
| From class[SemioticClassBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.SemioticClassBuilder) |---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | C | [setAnimacy](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.SemioticClassBuilder#setAnimacy(kotlin.String))`(`animacy:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` <br /> Sets the animacy information for this instance. <br />                     | | C | [setCase](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.SemioticClassBuilder#setCase(kotlin.String))`(`grammaticalCase:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` <br /> Sets the grammatical case information for this instance. <br />          | | C | [setGender](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.SemioticClassBuilder#setGender(kotlin.String))`(`gender:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` <br /> Sets the gender information for this instance. <br />                         | | C | [setMultiplicity](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.SemioticClassBuilder#setMultiplicity(kotlin.String))`(`multiplicity:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` <br /> Sets the multiplicity information for this instance. <br /> | ||

## Public constructors

### CardinalBuilder

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

```
CardinalBuilder()
```

Creates a builder for a TtsSpan of type[TYPE_CARDINAL](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#TYPE_CARDINAL:kotlin.String).  

### CardinalBuilder

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

```
CardinalBuilder(number: String!)
```

Creates a TtsSpan of type[TYPE_CARDINAL](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#TYPE_CARDINAL:kotlin.String)and sets the[ARG_NUMBER](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#ARG_NUMBER:kotlin.String)argument.

|                                                      Parameters                                                       ||
|----------|-------------------------------------------------------------------------------------------------------------|
| `number` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:The number to synthesize. |

**See Also**

- [#setNumber(String)](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#setNumber(kotlin.String))  

### CardinalBuilder

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

```
CardinalBuilder(number: Long)
```

Creates a TtsSpan of type[TYPE_CARDINAL](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#TYPE_CARDINAL:kotlin.String)and sets the[ARG_NUMBER](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#ARG_NUMBER:kotlin.String)argument.

|                                                    Parameters                                                    ||
|----------|--------------------------------------------------------------------------------------------------------|
| `number` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html):The number to synthesize. |

**See Also**

- [#setNumber(long)](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#setNumber(kotlin.Long))

## Public methods

### setNumber

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

```
open fun setNumber(number: String!): TtsSpan.CardinalBuilder!
```

Sets the[ARG_NUMBER](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#ARG_NUMBER:kotlin.String)argument.

|                                                                        Parameters                                                                         ||
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `number` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:A non-empty string of digits with an optional leading + or -. |

|                                                                 Return                                                                 ||
|------------------------------------------------------------------------------------------------------------------------|----------------|
| [TtsSpan.CardinalBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#)! | This instance. |

### setNumber

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

```
open fun setNumber(number: Long): TtsSpan.CardinalBuilder!
```

Convenience method that converts the number to a String and set it to the value for[ARG_NUMBER](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan#ARG_NUMBER:kotlin.String).

|                                                         Parameters                                                          ||
|----------|-------------------------------------------------------------------------------------------------------------------|
| `number` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html):The number that will be synthesized. |

|                                                                 Return                                                                 ||
|------------------------------------------------------------------------------------------------------------------------|----------------|
| [TtsSpan.CardinalBuilder](https://developer.android.com/reference/kotlin/android/text/style/TtsSpan.CardinalBuilder#)! | This instance. |