WifiSsid
public
final
class
WifiSsid
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.net.wifi.WifiSsid |
Representation of a Wi-Fi Service Set Identifier (SSID).
Summary
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<WifiSsid> |
CREATOR
Implement the Parcelable interface |
Public methods | |
---|---|
int
|
describeContents()
Implement the Parcelable interface |
boolean
|
equals(Object thatObject)
Indicates whether some other object is "equal to" this one. |
static
WifiSsid
|
fromBytes(byte[] bytes)
Create a WifiSsid from the raw bytes. |
byte[]
|
getBytes()
Returns the raw byte array representing this SSID. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns the string representation of the WifiSsid. |
void
|
writeToParcel(Parcel dest, int flags)
Implement the Parcelable interface |
Inherited methods | |
---|---|
Fields
CREATOR
public static final Creator<WifiSsid> CREATOR
Implement the Parcelable interface
Public methods
describeContents
public int describeContents ()
Implement the Parcelable interface
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. |
fromBytes
public static WifiSsid fromBytes (byte[] bytes)
Create a WifiSsid from the raw bytes. If the byte array is null, return an empty WifiSsid object which will return an empty byte array and empty text.
Parameters | |
---|---|
bytes |
byte : This value may be null . |
Returns | |
---|---|
WifiSsid |
getBytes
public byte[] getBytes ()
Returns the raw byte array representing this SSID.
Returns | |
---|---|
byte[] |
the SSID
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
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. |
toString
public String toString ()
Returns the string representation of the WifiSsid. If the SSID can be decoded as UTF-8, it
will be returned in plain text surrounded by double quotation marks. Otherwise, it is
returned as an unquoted string of hex digits. This format is consistent with
WifiInfo#getSSID()
and WifiConfiguration#SSID
.
Returns | |
---|---|
String |
SSID as double-quoted plain text from UTF-8 or unquoted hex digits
This value cannot be null . |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Implement the Parcelable interface
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 |