Added in API level 33

Summary: Inherited Constants | Fields | Methods | Inherited Methods

WifiSsid

---

Kotlin |Java

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

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

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
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 33

public static final Creator<WifiSsid> CREATOR

Implement the Parcelable interface

Public methods

describeContents

Added in API level 33

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

Added in API level 33

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

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

Added in API level 33

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

Added in API level 33

public byte[] getBytes ()

Returns the raw byte array representing this SSID.

Returns
byte[]	the SSID This value cannot be null.

hashCode

Added in API level 33

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

Returns
int	a hash code value for this object.

toString

Added in API level 33

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

Added in API level 33

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