Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Inherited Constants](https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#inhconstants) \| [Fields](https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#lfields) \| [Ctors](https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#pubctors) \| [Methods](https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#inhmethods)
# HomeSp
*** ** * ** ***
` public final class HomeSp `
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `
|---|---|
| [java.lang.Object](https://developer.android.com/reference/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 `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`
Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`
Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator` | `https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#CREATOR`
|
| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#HomeSp()() ` Constructor for creating HomeSp with default values. |
| ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#HomeSp(android.net.wifi.hotspot2.pps.HomeSp)(https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp source) ` Copy constructor. |
| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object thatObject) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#getFqdn()() ` Get the FQDN (Fully Qualified Domain Name) associated with this home service provider. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#getFriendlyName()() ` Get the friendly name associated with this home service provider. |
| ` long[]` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#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[]` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#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. |
| ` https://developer.android.com/reference/java/util/Collection` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#getOtherHomePartnersList()() ` Get the list of FQDN (Fully Qualified Domain Name) of other Home partner providers set in the profile. |
| ` long[]` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#getRoamingConsortiumOis()() ` Get the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member. |
| ` int` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#hashCode()() ` Returns a hash code value for the object. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#setFqdn(java.lang.String)(https://developer.android.com/reference/java/lang/String fqdn) ` Set the FQDN (Fully Qualified Domain Name) associated with this home service provider. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#setFriendlyName(java.lang.String)(https://developer.android.com/reference/java/lang/String friendlyName) ` Set the friendly name associated with this home service provider. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#setMatchAllOis(long[])(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` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#setMatchAnyOis(long[])(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` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#setOtherHomePartnersList(java.util.Collection)(https://developer.android.com/reference/java/util/Collection otherHomePartners) ` Set the list of FQDN (Fully Qualified Domain Name) of other Home partner providers. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#setRoamingConsortiumOis(long[])(long[] roamingConsortiumOis) ` Set the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |
### Inherited methods
From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `
Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `
Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class` ` https://developer.android.com/reference/java/lang/Object#getClass()() `
Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `
Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `
Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `
Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `
Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `
Flatten this object in to a Parcel.
## Fields
### CREATOR
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
## Public constructors
### HomeSp
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public HomeSp ()
```
Constructor for creating HomeSp with default values.
### HomeSp
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public HomeSp (HomeSp source)
```
Copy constructor.
| Parameters ||
|---|---|
| `source` | `HomeSp`: The source to copy from
|
## Public methods
### describeContents
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#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 - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |
### equals
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getFqdn ()
```
Get the FQDN (Fully Qualified Domain Name) associated with this home service provider.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the FQDN associated with this home service provider
|
### getFriendlyName
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getFriendlyName ()
```
Get the friendly name associated with this home service provider.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the friendly name associated with this home service provider
|
### getMatchAllOis
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Collection getOtherHomePartnersList ()
```
Get the list of FQDN (Fully Qualified Domain Name) of other Home partner providers set in the profile.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Collection` | 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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/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 `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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#setMatchAnyOis(long[])`, meaning the list set in `https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#setMatchAllOis(long[])` will have precedence over this API, meaning this list will only be used for matching if the list set by `https://developer.android.com/reference/android/net/wifi/hotspot2/pps/HomeSp#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setOtherHomePartnersList (Collection 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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Returns a string representation of the object.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object.
|
### writeToParcel
Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |