Added in API level 29

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

TextLanguage

---

Kotlin |Java

public final class TextLanguage
extends Object implements Parcelable

java.lang.Object
↳	android.view.textclassifier.TextLanguage

---

Represents the result of language detection of a piece of text.

This contains a list of locales, each paired with a confidence score, sorted in decreasing order of those scores. E.g., for a given input text, the model may return [<"en", 0.85>, <"fr", 0.15>]. This sample result means the model reports that it is 85% likely that the entire text is in English and 15% likely that the entire text is in French, etc. It does not mean that 85% of the input is in English and 15% is in French.

Summary

Nested classes
class	TextLanguage.Builder Builder used to build TextLanguage objects.
class	TextLanguage.Request A request object for detecting the language of a piece of text.

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<TextLanguage>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
float	getConfidenceScore(ULocale locale) Returns the confidence score for the specified language locale.
Bundle	getExtras() Returns a bundle containing non-structured extra information about this result.
String	getId() Returns the id, if one exists, for this object.
ULocale	getLocale(int index) Returns the language locale at the specified index.
int	getLocaleHypothesisCount() Returns the number of possible locales for the processed text.
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 29

public static final Creator<TextLanguage> CREATOR

Public methods

describeContents

Added in API level 29

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

getConfidenceScore

Added in API level 29

public float getConfidenceScore (ULocale locale)

Returns the confidence score for the specified language locale. The value ranges from 0 (low confidence) to 1 (high confidence). 0 indicates that the locale was not found for the processed text.

Parameters
locale	ULocale: This value cannot be null.

Returns
float	Value is between 0.0 and 1.0 inclusive

getExtras

Added in API level 29

public Bundle getExtras ()

Returns a bundle containing non-structured extra information about this result. What is returned in the extras is specific to the TextClassifier implementation.

NOTE: Do not modify this bundle.

Returns
Bundle	This value cannot be null.

getId

Added in API level 29

public String getId ()

Returns the id, if one exists, for this object.

Returns
String	This value may be null.

getLocale

Added in API level 29

public ULocale getLocale (int index)

Returns the language locale at the specified index. Locales are ordered from high confidence to low confidence.

See getLocaleHypothesisCount() for the number of locales available.

Parameters
index	int

Returns
ULocale	This value cannot be null.

Throws
IndexOutOfBoundsException	if the specified index is out of range.

getLocaleHypothesisCount

Added in API level 29

public int getLocaleHypothesisCount ()

Returns the number of possible locales for the processed text.

Returns
int	Value is 0 or greater

toString

Added in API level 29

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 29

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: The Parcel in which the object should be written. 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