Added in API level 34

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

AlternativeSpan

Kotlin |Java

public final class AlternativeSpan
extends Object implements Parcelable

java.lang.Object
↳	android.speech.AlternativeSpan

List of alternative hypotheses for a specific span of a speech recognition result string.

A single SpeechRecognizer result is represented as a String. For a specific span of the originally recognized result string, the recognizer may provide alternative hypotheses of what it may have recognized. A span is specifically a substring and is thereby defined by its start and end positions in the originally recognized string. Alternative hypotheses are represented as strings which may replace that substring.

These alternatives can be used to enhance recognition by adding/re-ranking/applying or in other ways manipulating the SpeechRecognizer results before powering dictation features.

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<AlternativeSpan>`	`CREATOR`

Public constructors
`AlternativeSpan(int startPosition, int endPosition, List<String> alternatives)` Creates a new AlternativeSpan.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`List<String>`	`getAlternatives()` All the alternatives for the [mStart, mEnd) span.
`int`	`getEndPosition()` The exclusive end position of the span of the originally recognized string.
`int`	`getStartPosition()` The start position of the span of the originally recognized string.
`int`	`hashCode()` Returns a hash code value for the object.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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(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()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 34

public static final Creator<AlternativeSpan> CREATOR

Public constructors

AlternativeSpan

Added in API level 34

public AlternativeSpan (int startPosition, 
                int endPosition, 
                List<String> alternatives)

Creates a new AlternativeSpan.

Parameters

Parameters
`startPosition`	`int`: The start position of the span of the originally recognized string. Must be set to a non-negative value before building.
`endPosition`	`int`: The exclusive end position of the span of the originally recognized string. Must be set to a value greater than the start of the span before building.
`alternatives`	`List`: All the alternatives for the [mStart, mEnd) span. Must not be empty. The object will only be created if there are some alternatives for the given span. The alternatives may be strings of different lengths than the span they can replace. This value cannot be `null`.

startPosition

int: The start position of the span of the originally recognized string.

Must be set to a non-negative value before building.

endPosition

int: The exclusive end position of the span of the originally recognized string.

Must be set to a value greater than the start of the span before building.

alternatives

List: All the alternatives for the [mStart, mEnd) span.

Must not be empty. The object will only be created if there are some alternatives for the given span.

The alternatives may be strings of different lengths than the span they can replace. This value cannot be null.

Public methods

describeContents

Added in API level 34

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 34

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.

Parameters
`o`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getAlternatives

Added in API level 34

public List<String> getAlternatives ()

All the alternatives for the [mStart, mEnd) span.

Must not be empty. The object will only be created if there are some alternatives for the given span.

The alternatives may be strings of different lengths than the span they can replace.

Returns
`List<String>`	This value cannot be `null`.

getEndPosition

Added in API level 34

public int getEndPosition ()

The exclusive end position of the span of the originally recognized string.

Must be set to a value greater than the start of the span before building.

Returns
`int`

getStartPosition

Added in API level 34

public int getStartPosition ()

The start position of the span of the originally recognized string.

Must be set to a non-negative value before building.

Returns
`int`

hashCode

Added in API level 34

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

Returns
`int`	a hash code value for this object.

toString

Added in API level 34

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 34

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES