Added in API level 26

Summary: Inherited Constants | Fields | Methods | Inherited Methods

AutofillValue

---

Kotlin |Java

public final class AutofillValue
extends Object implements Parcelable

java.lang.Object
↳	android.view.autofill.AutofillValue

---

Abstracts how a View can be autofilled by an AutofillService.

Each AutofillValue is associated with a type, as defined by View.getAutofillType().

Summary

Inherited constants

From interface android.os.Parcelable 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<AutofillValue>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
static AutofillValue	forDate(long value) Creates a new AutofillValue to autofill a View representing a date.
static AutofillValue	forList(int value) Creates a new AutofillValue to autofill a View representing a selection list.
static AutofillValue	forText(CharSequence value) Creates a new AutofillValue to autofill a View representing a text field.
static AutofillValue	forToggle(boolean value) Creates a new AutofillValue to autofill a View representing a toggable field.
long	getDateValue() Gets the value to autofill a date field.
int	getListValue() Gets the value to autofill a selection list field.
CharSequence	getTextValue() Gets the value to autofill a text field.
boolean	getToggleValue() Gets the value to autofill a toggable field.
int	hashCode() Returns a hash code value for the object.
boolean	isDate() Checks if this is a date value.
boolean	isList() Checks if this is a list value.
boolean	isText() Checks if this is a text value.
boolean	isToggle() Checks if this is a toggle value.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel parcel, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object 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.
From interface android.os.Parcelable 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.

Fields

CREATOR

Added in API level 26

public static final Creator<AutofillValue> CREATOR

Public methods

describeContents

Added in API level 26

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 26

public boolean equals (Object obj)

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
obj	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

forDate

Added in API level 26

public static AutofillValue forDate (long value)

Creates a new AutofillValue to autofill a View representing a date.

See View.AUTOFILL_TYPE_DATE for more info.

Parameters
value	long

Returns
AutofillValue

forList

Added in API level 26

public static AutofillValue forList (int value)

Creates a new AutofillValue to autofill a View representing a selection list.

See View.AUTOFILL_TYPE_LIST for more info.

Parameters
value	int

Returns
AutofillValue

forText

Added in API level 26

public static AutofillValue forText (CharSequence value)

Creates a new AutofillValue to autofill a View representing a text field.

See View.AUTOFILL_TYPE_TEXT for more info.

Note: This method is not thread safe and can throw an exception if the value is modified by a different thread before it returns.

Parameters
value	CharSequence: This value may be null.

Returns
AutofillValue

forToggle

Added in API level 26

public static AutofillValue forToggle (boolean value)

Creates a new AutofillValue to autofill a View representing a toggable field.

See View.AUTOFILL_TYPE_TOGGLE for more info.

Parameters
value	boolean

Returns
AutofillValue

getDateValue

Added in API level 26

public long getDateValue ()

Gets the value to autofill a date field.

See View.AUTOFILL_TYPE_DATE for more info.

Returns
long

Throws
IllegalStateException	if the value is not a date value

getListValue

Added in API level 26

public int getListValue ()

Gets the value to autofill a selection list field.

See View.AUTOFILL_TYPE_LIST for more info.

Returns
int

Throws
IllegalStateException	if the value is not a list value

getTextValue

Added in API level 26

public CharSequence getTextValue ()

Gets the value to autofill a text field.

See View.AUTOFILL_TYPE_TEXT for more info.

Returns
CharSequence	This value cannot be null.

Throws
IllegalStateException	if the value is not a text value

getToggleValue

Added in API level 26

public boolean getToggleValue ()

Gets the value to autofill a toggable field.

See View.AUTOFILL_TYPE_TOGGLE for more info.

Returns
boolean

Throws
IllegalStateException	if the value is not a toggle value

hashCode

Added in API level 26

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.

isDate

Added in API level 26

public boolean isDate ()

Checks if this is a date value.

See View.AUTOFILL_TYPE_DATE for more info.

Returns
boolean

isList

Added in API level 26

public boolean isList ()

Checks if this is a list value.

See View.AUTOFILL_TYPE_LIST for more info.

Returns
boolean

isText

Added in API level 26

public boolean isText ()

Checks if this is a text value.

See View.AUTOFILL_TYPE_TEXT for more info.

Returns
boolean

isToggle

Added in API level 26

public boolean isToggle ()

Checks if this is a toggle value.

See View.AUTOFILL_TYPE_TOGGLE for more info.

Returns
boolean

toString

Added in API level 26

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 26

public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel	Parcel: The Parcel in which the object should be written. 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