Skip to content

Most visited

Recently visited

navigation

AutofillValue

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 getAutofillType().

Summary

Inherited constants

From interface android.os.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 is this is a date value.

boolean isList()

Checks is this is a list value.

boolean isText()

Checks is this is a text value.

boolean isToggle()

Checks is 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
From interface android.os.Parcelable

Fields

CREATOR

added in API level 26
Creator<AutofillValue> CREATOR

Public methods

describeContents

added in API level 26
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(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.

equals

added in API level 26
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.

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
obj Object: the reference object with which to compare.

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

forDate

added in API level 26
AutofillValue forDate (long value)

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

See AUTOFILL_TYPE_DATE for more info.

Parameters
value long

Returns
AutofillValue

forList

added in API level 26
AutofillValue forList (int value)

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

See AUTOFILL_TYPE_LIST for more info.

Parameters
value int

Returns
AutofillValue

forText

added in API level 26
AutofillValue forText (CharSequence value)

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

See AUTOFILL_TYPE_TEXT for more info.

Parameters
value CharSequence

This value may be null.

Returns
AutofillValue

forToggle

added in API level 26
AutofillValue forToggle (boolean value)

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

See AUTOFILL_TYPE_TOGGLE for more info.

Parameters
value boolean

Returns
AutofillValue

getDateValue

added in API level 26
long getDateValue ()

Gets the value to autofill a date field.

See AUTOFILL_TYPE_DATE for more info.

Returns
long

Throws
IllegalStateException if the value is not a date value

getListValue

added in API level 26
int getListValue ()

Gets the value to autofill a selection list field.

See AUTOFILL_TYPE_LIST for more info.

Returns
int

Throws
IllegalStateException if the value is not a list value

getTextValue

added in API level 26
CharSequence getTextValue ()

Gets the value to autofill a text field.

See AUTOFILL_TYPE_TEXT for more info.

Returns
CharSequence

This value will never be null.

Throws
IllegalStateException if the value is not a text value

getToggleValue

added in API level 26
boolean getToggleValue ()

Gets the value to autofill a toggable field.

See AUTOFILL_TYPE_TOGGLE for more info.

Returns
boolean

Throws
IllegalStateException if the value is not a toggle value

hashCode

added in API level 26
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(Object) 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(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.

isDate

added in API level 26
boolean isDate ()

Checks is this is a date value.

See AUTOFILL_TYPE_DATE for more info.

Returns
boolean

isList

added in API level 26
boolean isList ()

Checks is this is a list value.

See AUTOFILL_TYPE_LIST for more info.

Returns
boolean

isText

added in API level 26
boolean isText ()

Checks is this is a text value.

See AUTOFILL_TYPE_TEXT for more info.

Returns
boolean

isToggle

added in API level 26
boolean isToggle ()

Checks is this is a toggle value.

See AUTOFILL_TYPE_TOGGLE for more info.

Returns
boolean

toString

added in API level 26
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.

writeToParcel

added in API level 26
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.

flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)