TtsSpan.Builder

Class Overview

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
	TtsSpan.Builder(String type)

Public Constructors

TtsSpan.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.

Public Methods

TtsSpan

build()

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

setIntArgument(String arg, int value)

Sets an argument to an int value.

setLongArgument(String arg, long value)

Sets an argument to a long value.

setStringArgument(String arg, String value)

Sets an argument to a string value.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	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() 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	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, 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(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public TtsSpan build ()

Added in API level 21

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

Returns

A TtsSpan built with parameters of this builder.

public C setIntArgument (String arg, int value)

Added in API level 21

Sets an argument to an int value.

Parameters

arg	The argument name.
value	The value the argument should be set to.

public C setLongArgument (String arg, long value)

Added in API level 21

Sets an argument to a long value.

Parameters

arg	The argument name.
value	The value the argument should be set to.

public C setStringArgument (String arg, String value)

Added in API level 21

Sets an argument to a string value.

Parameters

arg	The argument name.
value	The value the argument should be set to.

Returns

This instance.

Results

Interfaces

Classes

Class Overview

Summary

Public Constructors

public TtsSpan.Builder (String type)

Public Methods

public TtsSpan build ()

Returns

public C setIntArgument (String arg, int value)

Parameters

public C setLongArgument (String arg, long value)

Parameters

public C setStringArgument (String arg, String value)

Parameters

Returns

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