Added in API level 26

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

HomeSp

---

Kotlin |Java

public final class HomeSp
extends Object implements Parcelable

java.lang.Object
↳	android.net.wifi.hotspot2.pps.HomeSp

---

Class representing HomeSP subtree in PerProviderSubscription (PPS) Management Object (MO) tree. For more info, refer to Hotspot 2.0 PPS MO defined in section 9.1 of the Hotspot 2.0 Release 2 Technical Specification.

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<HomeSp>	CREATOR

Public constructors
HomeSp() Constructor for creating HomeSp with default values.
HomeSp(HomeSp source) Copy constructor.

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.
String	getFqdn() Get the FQDN (Fully Qualified Domain Name) associated with this home service provider.
String	getFriendlyName() Get the friendly name associated with this home service provider.
long[]	getMatchAllOis() Get the list of HomeOIs such that all OIs in the list must match an OI in the Roaming Consortium advertised by a hotspot operator.
long[]	getMatchAnyOis() Get a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator.
Collection<String>	getOtherHomePartnersList() Get the list of FQDN (Fully Qualified Domain Name) of other Home partner providers set in the profile.
long[]	getRoamingConsortiumOis() Get the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.
int	hashCode() Returns a hash code value for the object.
void	setFqdn(String fqdn) Set the FQDN (Fully Qualified Domain Name) associated with this home service provider.
void	setFriendlyName(String friendlyName) Set the friendly name associated with this home service provider.
void	setMatchAllOis(long[] matchAllOis) Set a list of HomeOIs such that all OIs in the list must match an OI in the Roaming Consortium advertised by a hotspot operator.
void	setMatchAnyOis(long[] matchAnyOis) Set a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator.
void	setOtherHomePartnersList(Collection<String> otherHomePartners) Set the list of FQDN (Fully Qualified Domain Name) of other Home partner providers.
void	setRoamingConsortiumOis(long[] roamingConsortiumOis) Set the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

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 26

public static final Creator<HomeSp> CREATOR

Public constructors

HomeSp

Added in API level 26

public HomeSp ()

Constructor for creating HomeSp with default values.

HomeSp

Added in API level 26

public HomeSp (HomeSp source)

Copy constructor.

Parameters
source	HomeSp: The source to copy from

Public methods

describeContents

Added in API level 26

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

Added in API level 26

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.

getFqdn

Added in API level 26

public String getFqdn ()

Get the FQDN (Fully Qualified Domain Name) associated with this home service provider.

Returns
String	the FQDN associated with this home service provider

getFriendlyName

Added in API level 26

public String getFriendlyName ()

Get the friendly name associated with this home service provider.

Returns
String	the friendly name associated with this home service provider

getMatchAllOis

Added in API level 31

public long[] getMatchAllOis ()

Get the list of HomeOIs such that all OIs in the list must match an OI in the Roaming Consortium advertised by a hotspot operator.

Returns
long[]	An array of longs containing the HomeOIs This value may be null.

getMatchAnyOis

Added in API level 31

public long[] getMatchAnyOis ()

Get a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator.

Returns
long[]	An array of longs containing the HomeOIs This value may be null.

getOtherHomePartnersList

Added in API level 31

public Collection<String> getOtherHomePartnersList ()

Get the list of FQDN (Fully Qualified Domain Name) of other Home partner providers set in the profile.

Returns
Collection<String>	Collection of Strings containing the FQDNs of other Home partner providers set in the profile This value cannot be null.

getRoamingConsortiumOis

Added in API level 26

public long[] getRoamingConsortiumOis ()

Get the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.

Returns
long[]	array of roaming consortium OIs

hashCode

Added in API level 26

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.

setFqdn

Added in API level 26

public void setFqdn (String fqdn)

Set the FQDN (Fully Qualified Domain Name) associated with this home service provider.

Parameters
fqdn	String: The FQDN to set to

setFriendlyName

Added in API level 26

public void setFriendlyName (String friendlyName)

Set the friendly name associated with this home service provider.

Parameters
friendlyName	String: The friendly name to set to

setMatchAllOis

Added in API level 31

public void setMatchAllOis (long[] matchAllOis)

Set a list of HomeOIs such that all OIs in the list must match an OI in the Roaming Consortium advertised by a hotspot operator. The list set by this API will have precedence over setMatchAnyOis(long[]), meaning the list set in setMatchAnyOis(long[]) will only be used for matching if the list set by this API is null or empty.

Parameters
matchAllOis	long: An array of longs containing the HomeOIs This value may be null.

setMatchAnyOis

Added in API level 31

public void setMatchAnyOis (long[] matchAnyOis)

Set a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator. The list set by setMatchAllOis(long[]) will have precedence over this API, meaning this list will only be used for matching if the list set by setMatchAllOis(long[]) is null or empty.

Parameters
matchAnyOis	long: An array of longs containing the HomeOIs This value may be null.

setOtherHomePartnersList

Added in API level 31

public void setOtherHomePartnersList (Collection<String> otherHomePartners)

Set the list of FQDN (Fully Qualified Domain Name) of other Home partner providers.

Parameters
otherHomePartners	Collection: Collection of Strings containing the FQDNs of other Home partner providers This value cannot be null.

setRoamingConsortiumOis

Added in API level 26

public void setRoamingConsortiumOis (long[] roamingConsortiumOis)

Set the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.

Parameters
roamingConsortiumOis	long: Array of roaming consortium OIs

toString

Added in API level 26

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 26

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: The Parcel in which the object should be written. 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