Android APIs
public final class

LinkProperties

extends Object
implements Parcelable
java.lang.Object
   ↳ android.net.LinkProperties

Class Overview

Describes the properties of a network link. A link represents a connection to a network. It may have multiple addresses and multiple gateways, multiple dns servers but only one http proxy and one network interface. Note that this is just a holder of data. Modifying it does not affect live networks.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<LinkProperties> CREATOR Implement the Parcelable interface.
Public Methods
int describeContents()
Implement the Parcelable interface
boolean equals(Object obj)
Compares this instance with the specified object and indicates if they are equal.
List<InetAddress> getDnsServers()
Returns all the InetAddress for DNS servers on this link.
String getDomains()
Get the DNS domains search path set for this link.
ProxyInfo getHttpProxy()
Gets the recommended ProxyInfo (or null) set on this link.
String getInterfaceName()
Gets the interface name for this link.
List<LinkAddress> getLinkAddresses()
Returns all the LinkAddress on this link.
List<RouteInfo> getRoutes()
Returns all the RouteInfo set on this link.
int hashCode()
Returns an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel dest, int flags)
Implement the Parcelable interface.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<LinkProperties> CREATOR

Implement the Parcelable interface.

Public Methods

public int describeContents ()

Implement the Parcelable interface

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object obj)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
obj the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public List<InetAddress> getDnsServers ()

Returns all the InetAddress for DNS servers on this link.

Returns

public String getDomains ()

Get the DNS domains search path set for this link.

Returns
  • A String containing the comma separated domains to search when resolving host names on this link.

public ProxyInfo getHttpProxy ()

Gets the recommended ProxyInfo (or null) set on this link.

Returns

public String getInterfaceName ()

Gets the interface name for this link. May be null if not set.

Returns
  • The interface name set for this link or null.

public List<LinkAddress> getLinkAddresses ()

Returns all the LinkAddress on this link. Typically a link will have one IPv4 address and one or more IPv6 addresses.

Returns

public List<RouteInfo> getRoutes ()

Returns all the RouteInfo set on this link.

Returns

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel dest, int flags)

Implement the Parcelable interface.

Parameters
dest The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.