WifiSsidPolicy
public
final
class
WifiSsidPolicy
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.app.admin.WifiSsidPolicy |
Used to indicate the Wi-Fi SSID restriction policy the network must satisfy in order to be eligible for a connection. If the policy type is a denylist, the device may not connect to networks on the denylist. If the policy type is an allowlist, the device may only connect to networks on the allowlist. Admin configured networks are not exempt from this restriction. This policy only prohibits connecting to a restricted network and does not affect adding a restricted network. If the current network is present in the denylist or not present in the allowlist, it will be disconnected.
Summary
Constants | |
|---|---|
int |
WIFI_SSID_POLICY_TYPE_ALLOWLIST
SSID policy type indicator for |
int |
WIFI_SSID_POLICY_TYPE_DENYLIST
SSID policy type indicator for |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<WifiSsidPolicy> |
CREATOR
|
Public constructors | |
|---|---|
WifiSsidPolicy(int policyType, Set<WifiSsid> ssids)
Create the Wi-Fi SSID 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. |
int
|
getPolicyType()
Returns the policy type. |
Set<WifiSsid>
|
getSsids()
Returns the set of |
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
WIFI_SSID_POLICY_TYPE_ALLOWLIST
public static final int WIFI_SSID_POLICY_TYPE_ALLOWLIST
SSID policy type indicator for WifiSsidPolicy.
When returned from WifiSsidPolicy#getPolicyType(), the constant
indicates that the SSID policy type is an allowlist.
See also:
Constant Value: 0 (0x00000000)
WIFI_SSID_POLICY_TYPE_DENYLIST
public static final int WIFI_SSID_POLICY_TYPE_DENYLIST
SSID policy type indicator for WifiSsidPolicy.
When returned from WifiSsidPolicy#getPolicyType(), the constant
indicates that the SSID policy type is a denylist.
See also:
Constant Value: 1 (0x00000001)
Fields
Public constructors
WifiSsidPolicy
public WifiSsidPolicy (int policyType,
Set<WifiSsid> ssids)
Create the Wi-Fi SSID Policy.
| Parameters | |
|---|---|
policyType |
int: indicate whether the policy is an allowlist or a denylist
Value is WIFI_SSID_POLICY_TYPE_ALLOWLIST, or WIFI_SSID_POLICY_TYPE_DENYLIST |
ssids |
Set: set of WifiSsid
This value cannot be null. |
| Throws | |
|---|---|
IllegalArgumentException |
if the input ssids set is empty or the policyType is invalid |
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
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 | |
|---|---|
thatObject |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getPolicyType
public int getPolicyType ()
Returns the policy type.
| Returns | |
|---|---|
int |
Value is WIFI_SSID_POLICY_TYPE_ALLOWLIST, or WIFI_SSID_POLICY_TYPE_DENYLIST |
getSsids
public Set<WifiSsid> getSsids ()
Returns the set of WifiSsid
| Returns | |
|---|---|
Set<WifiSsid> |
This value cannot be null. |
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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 thehashCodemethod 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 thehashCodemethod 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. |
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 |