# Print output for @column tags ?>
public
final
class
TranslationResponseValue
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.view.translation.TranslationResponseValue |
A translated response value from TranslationService
.
Nested classes | |
---|---|
class |
TranslationResponseValue.Builder
A builder for |
Constants | |
---|---|
String |
EXTRA_DEFINITIONS
Name in the result of |
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 |
Bundle
|
getExtras()
Extra results associated with the translated text. |
int
|
getStatusCode()
The status code of this |
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 | |
---|---|
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 CharSequence
s.
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"
public static final int STATUS_ERROR
This value was not successfully translated. No value can be obtained with getText()
.
Constant Value: 1 (0x00000001)
public static final int STATUS_SUCCESS
This value was successfully translated.
Constant Value: 0 (0x00000000)
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 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:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
Parameters | |
---|---|
o |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public static TranslationResponseValue forError ()
Creates a TranslationResponseValue
with the STATUS_ERROR
result;
Returns | |
---|---|
TranslationResponseValue |
This value cannot be null . |
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 . |
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 |
public CharSequence getText ()
The translated text result.
Returns | |
---|---|
CharSequence |
This value may be null . |
public CharSequence getTransliteration ()
The transliteration result of the translated text. TODO: Describe the result structure.
Returns | |
---|---|
CharSequence |
This value may be null . |
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:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
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.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
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 : 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 |