Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public final class

UserHandle

extends Object
implements Parcelable
java.lang.Object
   ↳ android.os.UserHandle

Class Overview

Representation of a user on the device.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator < UserHandle > CREATOR
Public Constructors
UserHandle ( Parcel in)
Instantiate a new UserHandle from the data in a Parcel that was previously written with writeToParcel(Parcel, int) .
Public Methods
int describeContents ()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals ( Object obj)
Compares this instance with the specified object and indicates if they are equal.
int hashCode ()
Returns an integer hash code for this object.
static UserHandle readFromParcel ( Parcel in)
Read a UserHandle from a Parcel that was previously written with writeToParcel(UserHandle, Parcel) , returning either a null or new object as appropriate.
String toString ()
Returns a string containing a concise, human-readable description of this object.
static void writeToParcel ( UserHandle h, Parcel out)
Write a UserHandle to a Parcel, handling null pointers.
void writeToParcel ( Parcel out, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator < UserHandle > CREATOR

Public Constructors

public UserHandle ( Parcel in)

Instantiate a new UserHandle from the data in a Parcel that was previously written with writeToParcel(Parcel, int) . Note that you must not use this with data written by writeToParcel(UserHandle, Parcel) since it is not possible to handle a null UserHandle here.

Parameters
in The Parcel containing the previously written UserHandle, positioned at the location in the buffer where it was written.

Public Methods

public int describeContents ()

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

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals ( Object obj)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o . See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
obj the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object ; false otherwise.

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public static UserHandle readFromParcel ( Parcel in)

Read a UserHandle from a Parcel that was previously written with writeToParcel(UserHandle, Parcel) , returning either a null or new object as appropriate.

Parameters
in The Parcel from which to read the UserHandle
Returns
  • Returns a new UserHandle matching the previously written object, or null if a null had been written.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

          getClass().getName() + '@' + Integer.toHexString(hashCode())
         

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public static void writeToParcel ( UserHandle h, Parcel out)

Write a UserHandle to a Parcel, handling null pointers. Must be read with readFromParcel(Parcel) .

Parameters
h The UserHandle to be written.
out The Parcel in which the UserHandle will be placed.

public void writeToParcel ( Parcel out, int flags)

Flatten this object in to a Parcel.

Parameters
out The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE .