TranslationContext


public final class TranslationContext
extends Object implements Parcelable

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


Info class holding information for Translators and used by TranslationManager.createOnDeviceTranslator(TranslationContext, Executor, Consumer).

Summary

Nested classes

class TranslationContext.Builder

A builder for TranslationContext 

Constants

int FLAG_DEFINITIONS

This context will enable the Translator to return dictionary definitions.

int FLAG_LOW_LATENCY

This context will perform translations in low latency mode.

int FLAG_TRANSLITERATION

This context will enable the Translator to return transliteration results.

Inherited constants

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

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

TranslationSpec getSourceSpec()

TranslationSpec describing the source data to be translated.

TranslationSpec getTargetSpec()

TranslationSpec describing the target translated data.

int getTranslationFlags()

Translation flags to be used by the Translator

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

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.

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.

Constants

FLAG_DEFINITIONS

Added in API level 31
public static final int FLAG_DEFINITIONS

This context will enable the Translator to return dictionary definitions.
Value is either 0 or a combination of FLAG_LOW_LATENCY, FLAG_TRANSLITERATION, and FLAG_DEFINITIONS

Constant Value: 4 (0x00000004)

FLAG_LOW_LATENCY

Added in API level 31
public static final int FLAG_LOW_LATENCY

This context will perform translations in low latency mode.
Value is either 0 or a combination of FLAG_LOW_LATENCY, FLAG_TRANSLITERATION, and FLAG_DEFINITIONS

Constant Value: 1 (0x00000001)

FLAG_TRANSLITERATION

Added in API level 31
public static final int FLAG_TRANSLITERATION

This context will enable the Translator to return transliteration results.
Value is either 0 or a combination of FLAG_LOW_LATENCY, FLAG_TRANSLITERATION, and FLAG_DEFINITIONS

Constant Value: 2 (0x00000002)

Fields

CREATOR

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

getSourceSpec

Added in API level 31
public TranslationSpec getSourceSpec ()

TranslationSpec describing the source data to be translated.

Returns
TranslationSpec This value cannot be null.

getTargetSpec

Added in API level 31
public TranslationSpec getTargetSpec ()

TranslationSpec describing the target translated data.

Returns
TranslationSpec This value cannot be null.

getTranslationFlags

Added in API level 31
public int getTranslationFlags ()

Translation flags to be used by the Translator

Returns
int Value is either 0 or a combination of FLAG_LOW_LATENCY, FLAG_TRANSLITERATION, and FLAG_DEFINITIONS

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