TtsSpan.Builder

public static class TtsSpan.Builder
extends Object

java.lang.Object
   ↳ android.text.style.TtsSpan.Builder<C extends android.text.style.TtsSpan.Builder<?>>


A simple builder for TtsSpans. This builder can be used directly, but the more specific subclasses of this builder like TtsSpan.TextBuilder and 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(String type)

Public methods

TtsSpan build()

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

C setIntArgument(String arg, int value)

Sets an argument to an int value.

C setLongArgument(String arg, long value)

Sets an argument to a long value.

C setStringArgument(String arg, String value)

Sets an argument to a string value.

Inherited methods

Public constructors

Builder

Added in API level 21
public Builder (String type)

Parameters
type String

Public methods

build

Added in API level 21
public TtsSpan build ()

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

Returns
TtsSpan A TtsSpan built with parameters of this builder.

setIntArgument

Added in API level 21
public C setIntArgument (String arg, 
                int value)

Sets an argument to an int value.

Parameters
arg String: The argument name.

value int: The value the argument should be set to.

Returns
C

setLongArgument

Added in API level 21
public C setLongArgument (String arg, 
                long value)

Sets an argument to a long value.

Parameters
arg String: The argument name.

value long: The value the argument should be set to.

Returns
C

setStringArgument

Added in API level 21
public C setStringArgument (String arg, 
                String value)

Sets an argument to a string value.

Parameters
arg String: The argument name.

value String: The value the argument should be set to.

Returns
C This instance.