PackagePolicy
public
final
class
PackagePolicy
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.admin.PackagePolicy |
A generic class that defines which APK packages are in scope for some device policy.
The packages can be defined using either an allowlist or a blocklist. In allowlist mode, it could optionally include all system packages that meet the specific criteria of the device policy in question.
Summary
Constants | |
---|---|
int |
PACKAGE_POLICY_ALLOWLIST
PackagePolicy type indicator for
This constant indicates that all packages are denied except for the packages returned by
|
int |
PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM
PackagePolicy type indicator for
This constant indicates system packages are allowed in addition to the packages returned by
|
int |
PACKAGE_POLICY_BLOCKLIST
PackagePolicy type indicator for
This constant indicates that all packages are allowed except for the packages returned by
|
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<PackagePolicy> |
CREATOR
|
Public constructors | |
---|---|
PackagePolicy(int policyType)
Create the package policy |
|
PackagePolicy(int policyType, Set<String> packageNames)
Create the package policy |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object thatObject)
Indicates whether some other object is "equal to" this one. |
Set<String>
|
getPackageNames()
Returns the list of packages to use as an allow/deny list based on policy type |
int
|
getPolicyType()
Returns the current policy type |
int
|
hashCode()
Returns a hash code value for the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
PACKAGE_POLICY_ALLOWLIST
public static final int PACKAGE_POLICY_ALLOWLIST
PackagePolicy type indicator for PackagePolicy
This constant indicates that all packages are denied except for the packages returned by
PackagePolicy#getPackageNames()
, which acts as an allowlist.
Constant Value: 3 (0x00000003)
PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM
public static final int PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM
PackagePolicy type indicator for PackagePolicy
This constant indicates system packages are allowed in addition to the packages returned by
PackagePolicy#getPackageNames()
, which acts as an allowlist.
Functions that accept PackagePolicy
will further clarify
how this policy is interpreted.
Constant Value: 2 (0x00000002)
PACKAGE_POLICY_BLOCKLIST
public static final int PACKAGE_POLICY_BLOCKLIST
PackagePolicy type indicator for PackagePolicy
This constant indicates that all packages are allowed except for the packages returned by
PackagePolicy#getPackageNames()
, which acts as a denylist.
Constant Value: 1 (0x00000001)
Fields
Public constructors
PackagePolicy
public PackagePolicy (int policyType)
Create the package policy
Parameters | |
---|---|
policyType |
int : indicates how to interpret this policy
Value is PACKAGE_POLICY_BLOCKLIST , PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM , or PACKAGE_POLICY_ALLOWLIST |
See also:
PackagePolicy
public PackagePolicy (int policyType, Set<String> packageNames)
Create the package policy
Parameters | |
---|---|
policyType |
int : indicates how to interpret this policy
Value is PACKAGE_POLICY_BLOCKLIST , PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM , or PACKAGE_POLICY_ALLOWLIST |
packageNames |
Set : allowlist or a denylist, based on policyType
This value cannot be null . |
Public methods
describeContents
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
public boolean equals (Object thatObject)
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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 | |
---|---|
thatObject |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getPackageNames
public Set<String> getPackageNames ()
Returns the list of packages to use as an allow/deny list based on policy type
Returns | |
---|---|
Set<String> |
This value cannot be null . |
getPolicyType
public int getPolicyType ()
Returns the current policy type
Returns | |
---|---|
int |
Value is PACKAGE_POLICY_BLOCKLIST , PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM , or PACKAGE_POLICY_ALLOWLIST |
hashCode
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 inequals
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 thehashCode
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 thehashCode
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. |
writeToParcel
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 |