TranslationResponseValue


public final class TranslationResponseValue
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.translation.TranslationResponseValue


A translated response value from translation service.

Summary

Nested classes

class TranslationResponseValue.Builder

A builder for TranslationResponseValue 

Constants

String EXTRA_DEFINITIONS

Name in the result of getExtras() to pass dictionary definitions of the text categorized by parts of speech.

int STATUS_ERROR

This value was not successfully translated.

int STATUS_SUCCESS

This value was successfully translated.

Inherited constants

Fields

public static final Creator<TranslationResponseValue> CREATOR

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.

static TranslationResponseValue forError()

Creates a TranslationResponseValue with the STATUS_ERROR result;

Bundle getExtras()

Extra results associated with the translated text.

int getStatusCode()

The status code of this TranslationResponseValue.

CharSequence getText()

The translated text result.

CharSequence getTransliteration()

The transliteration result of the translated text.

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

Constants

EXTRA_DEFINITIONS

Added in API level 31
public static final String EXTRA_DEFINITIONS

Name in the result of getExtras() to pass dictionary definitions of the text categorized by parts of speech.

The dictionary definitions consists of groups of terms keyed by their corresponding parts of speech. This map-like structure is stored in a Bundle. The individual parts of speech can be traversed by Bundle#keySet() and used to get the corresponding list of terms as CharSequences.

  • "noun" -> ["def1", "def2", ...]
  • "verb" -> ["def3", "def4", ...]
  • ...
The set of parts of speech can then be used by Bundle#getCharSequenceArrayList(String) to get the list of terms. Example: for (String partOfSpeech : extras.getBundle(EXTRA_DEFINITIONS).keySet()) { ArrayList<CharSequence> terms = extras.getBundle(EXTRA_DEFINITIONS).getCharSequenceArrayList(partOfSpeech); ... }

Constant Value: "android.view.translation.extra.DEFINITIONS"

STATUS_ERROR

Added in API level 31
public static final int STATUS_ERROR

This value was not successfully translated. No value can be obtained with getText().

Constant Value: 1 (0x00000001)

STATUS_SUCCESS

Added in API level 31
public static final int STATUS_SUCCESS

This value was successfully translated.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 31
public static final Creator<TranslationResponseValue> CREATOR

Public methods

describeContents

Added in API level 31
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 31
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.

forError

Added in API level 31
public static TranslationResponseValue forError ()

Creates a TranslationResponseValue with the STATUS_ERROR result;

Returns
TranslationResponseValue This value cannot be null.

getExtras

Added in API level 31
public Bundle getExtras ()

Extra results associated with the translated text.

The bundle includes EXTRA_DEFINITIONS, obtained by Bundle#getBundle.

Returns
Bundle This value cannot be null.

getStatusCode

Added in API level 31
public int getStatusCode ()

The status code of this TranslationResponseValue.

If the status code is STATUS_ERROR, no values are attached, and all getters will return null.

Returns
int Value is STATUS_SUCCESS, or STATUS_ERROR

getText

Added in API level 31
public CharSequence getText ()

The translated text result.

Returns
CharSequence This value may be null.

getTransliteration

Added in API level 31
public CharSequence getTransliteration ()

The transliteration result of the translated text.

This returns a CharSequence representation of the transliteration of the translated text.

Returns
CharSequence This value may be null.

hashCode

Added in API level 31
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 31
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 31
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