Most visited

Recently visited

Added in API level 17

UserHandle

public final class UserHandle
extends Object implements Parcelable

java.lang.Object
   ↳ android.os.UserHandle


Representation of a user on the device.

Summary

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 instance's marshaled representation.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

static UserHandle getUserHandleForUid(int uid)

Returns the user for a given uid.

int hashCode()

Returns a hash code value for the 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 representation of the 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.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

Added in API level 17
Creator<UserHandle> CREATOR

Public constructors

UserHandle

Added in API level 17
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 Parcel: The Parcel containing the previously written UserHandle, positioned at the location in the buffer where it was written.

Public methods

describeContents

Added in API level 17
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 17
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.

getUserHandleForUid

Added in API level 24
UserHandle getUserHandleForUid (int uid)

Returns the user for a given uid.

Parameters
uid int: A uid for an application running in a particular user.
Returns
UserHandle A UserHandle for that user.

hashCode

Added in API level 17
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 JavaTM programming language.)

Returns
int a hash code value for this object.

readFromParcel

Added in API level 17
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 Parcel: The Parcel from which to read the UserHandle
Returns
UserHandle Returns a new UserHandle matching the previously written object, or null if a null had been written.

See also:

toString

Added in API level 17
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 17
void writeToParcel (UserHandle h, 
                Parcel out)

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

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

See also:

writeToParcel

Added in API level 17
void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out 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.

Hooray!