HomeSp
class HomeSp : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
| Public constructors | |
|---|---|
HomeSp()Constructor for creating HomeSp with default values. |
|
|
Copy constructor. |
|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
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! |
Get the friendly name associated with this home service provider. |
| LongArray? |
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. |
| LongArray? |
Get a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator. |
| MutableCollection<String!> |
Get the list of FQDN (Fully Qualified Domain Name) of other Home partner providers set in the profile. |
| LongArray! |
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. |
| Unit |
Set the FQDN (Fully Qualified Domain Name) associated with this home service provider. |
| Unit |
setFriendlyName(friendlyName: String!)Set the friendly name associated with this home service provider. |
| Unit |
setMatchAllOis(matchAllOis: LongArray?)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. |
| Unit |
setMatchAnyOis(matchAnyOis: LongArray?)Set a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator. |
| Unit |
setOtherHomePartnersList(otherHomePartners: MutableCollection<String!>)Set the list of FQDN (Fully Qualified Domain Name) of other Home partner providers. |
| Unit |
setRoamingConsortiumOis(roamingConsortiumOis: LongArray!)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. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<HomeSp!> | |
Public constructors
HomeSp
HomeSp(source: HomeSp!)
Copy constructor.
| Parameters | |
|---|---|
source |
HomeSp!: The source to copy from |
Public methods
describeContents
fun describeContents(): Int
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.
| 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. |
getFqdn
fun getFqdn(): String!
Get the FQDN (Fully Qualified Domain Name) associated with this home service provider.
| Return | |
|---|---|
String! |
the FQDN associated with this home service provider |
getFriendlyName
fun getFriendlyName(): String!
Get the friendly name associated with this home service provider.
| Return | |
|---|---|
String! |
the friendly name associated with this home service provider |
getMatchAllOis
fun getMatchAllOis(): LongArray?
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.
| Return | |
|---|---|
LongArray? |
An array of longs containing the HomeOIs. This value may be null. |
getMatchAnyOis
fun getMatchAnyOis(): LongArray?
Get a list of HomeOIs such that any OI in the list matches an OI in the Roaming Consortium advertised by a hotspot operator.
| Return | |
|---|---|
LongArray? |
An array of longs containing the HomeOIs. This value may be null. |
getOtherHomePartnersList
fun getOtherHomePartnersList(): MutableCollection<String!>
Get the list of FQDN (Fully Qualified Domain Name) of other Home partner providers set in the profile.
| Return | |
|---|---|
MutableCollection<String!> |
Collection of Strings containing the FQDNs of other Home partner providers set in the profile. This value cannot be null. |
getRoamingConsortiumOis
fun getRoamingConsortiumOis(): LongArray!
Get the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.
| Return | |
|---|---|
LongArray! |
array of roaming consortium OIs |
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. |
setFqdn
fun setFqdn(fqdn: String!): Unit
Set the FQDN (Fully Qualified Domain Name) associated with this home service provider.
| Parameters | |
|---|---|
fqdn |
String!: The FQDN to set to |
setFriendlyName
fun setFriendlyName(friendlyName: String!): Unit
Set the friendly name associated with this home service provider.
| Parameters | |
|---|---|
friendlyName |
String!: The friendly name to set to |
setMatchAllOis
fun setMatchAllOis(matchAllOis: LongArray?): Unit
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 |
LongArray?: An array of longs containing the HomeOIs. This value may be null. |
setMatchAnyOis
fun setMatchAnyOis(matchAnyOis: LongArray?): Unit
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 |
LongArray?: An array of longs containing the HomeOIs. This value may be null. |
setOtherHomePartnersList
fun setOtherHomePartnersList(otherHomePartners: MutableCollection<String!>): Unit
Set the list of FQDN (Fully Qualified Domain Name) of other Home partner providers.
| Parameters | |
|---|---|
otherHomePartners |
MutableCollection<String!>: Collection of Strings containing the FQDNs of other Home partner providers. This value cannot be null. |
setRoamingConsortiumOis
fun setRoamingConsortiumOis(roamingConsortiumOis: LongArray!): Unit
Set the Organization Identifiers (OIs) identifying a roaming consortium of which this provider is a member.
| Parameters | |
|---|---|
roamingConsortiumOis |
LongArray!: Array of roaming consortium OIs |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|