ViewTranslationRequest


public final class ViewTranslationRequest
extends Object implements Parcelable

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


Wrapper class representing a translation request associated with a View to be used by translation service.

Summary

Nested classes

class ViewTranslationRequest.Builder

A builder for building ViewTranslationRequest. 

Constants

String ID_TEXT

Constant id for the default view text to be translated.

Inherited constants

Fields

public static final Creator<ViewTranslationRequest> 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.

AutofillId getAutofillId()

Returns the associated AutofillId of this request.

Set<String> getKeys()

Returns all keys in this request as a Set of Strings.

TranslationRequestValue getValue(String key)

Gets the corresponding TranslationRequestValue of the provided key.

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

ID_TEXT

Added in API level 31
public static final String ID_TEXT

Constant id for the default view text to be translated. This is used by Builder.setValue(String, TranslationRequestValue).

Constant Value: "android:text"

Fields

CREATOR

Added in API level 31
public static final Creator<ViewTranslationRequest> 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.

getAutofillId

Added in API level 31
public AutofillId getAutofillId ()

Returns the associated AutofillId of this request.

Returns
AutofillId This value cannot be null.

getKeys

Added in API level 31
public Set<String> getKeys ()

Returns all keys in this request as a Set of Strings. The keys are used by getValue(java.lang.String) to get the TranslationRequestValues.

Returns
Set<String> This value cannot be null.

getValue

Added in API level 31
public TranslationRequestValue getValue (String key)

Gets the corresponding TranslationRequestValue of the provided key.

Parameters
key String: String id of the translation request value to be translated. This value cannot be null.

Returns
TranslationRequestValue the TranslationRequestValue. This value cannot be null.

Throws
IllegalArgumentException if the key does not exist.

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