HomeSp
  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 | 
|---|
| 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 | |
|---|---|
Fields
Public constructors
HomeSp
public HomeSp (HomeSp source)
Copy constructor.
| Parameters | |
|---|---|
| source | HomeSp: The source to copy from | 
Public methods
describeContents
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 0orCONTENTS_FILE_DESCRIPTOR | 
equals
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 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 | |
|---|---|
| thatObject | Object: the reference object with which to compare. | 
| Returns | |
|---|---|
| boolean | trueif this object is the same as the obj
          argument;falseotherwise. | 
getFqdn
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
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
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
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
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
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
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 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.
| Returns | |
|---|---|
| int | a hash code value for this object. | 
setFqdn
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
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
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 benull. | 
setMatchAnyOis
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 benull. | 
setOtherHomePartnersList
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 benull. | 
setRoamingConsortiumOis
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
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
| String | a string representation of the object. | 
writeToParcel
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 benull. | 
| flags | int: Additional flags about how the object should be written.
 May be 0 orParcelable.PARCELABLE_WRITE_RETURN_VALUE.
 Value is either0or a combination ofParcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
