# Print output for @column tags ?>
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.
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 |
|---|
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 | |
|---|---|
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 |
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 |
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. |
public String getId ()
Returns the id, if one exists, for this object.
| Returns | |
|---|---|
String |
This value may be null. |
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. |
public int getLocaleHypothesisCount ()
Returns the number of possible locales for the processed text.
| Returns | |
|---|---|
int |
Value is 0 or greater |
public String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
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. |
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 |