WifiSsid
class WifiSsid : Parcelable
| kotlin.Any | |
| ↳ | android.net.wifi.WifiSsid |
Representation of a Wi-Fi Service Set Identifier (SSID).
Summary
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Implement the Parcelable interface |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| static WifiSsid |
Create a WifiSsid from the raw bytes. |
| ByteArray |
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. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Implement the Parcelable interface |
| Properties | |
|---|---|
| static Parcelable.Creator<WifiSsid!> |
Implement the Parcelable interface |
Public methods
describeContents
fun describeContents(): Int
Implement the Parcelable interface
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
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.
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 | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
fromBytes
static fun fromBytes(bytes: ByteArray?): WifiSsid
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 |
ByteArray?: This value may be null. |
getBytes
fun getBytes(): ByteArray
Returns the raw byte array representing this SSID.
| Return | |
|---|---|
ByteArray |
the SSID. This value cannot be null. |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
equalsmethod, 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
equalsmethod, 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
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.
| Return | |
|---|---|
String |
SSID as double-quoted plain text from UTF-8 or unquoted hex digits. This value cannot be null. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|
Properties
CREATOR
static val CREATOR: Parcelable.Creator<WifiSsid!>
Implement the Parcelable interface