Most visited

Recently visited

Added in API level 21

LinkProperties

public final class LinkProperties
extends Object implements Parcelable

java.lang.Object
   ↳ android.net.LinkProperties


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

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)

Indicates whether some other object is "equal to" this one.

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 a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Implement the Parcelable interface.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

Added in API level 21
Creator<LinkProperties> CREATOR

Implement the Parcelable interface.

Public methods

describeContents

Added in API level 21
int describeContents ()

Implement the Parcelable interface

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

equals

Added in API level 21
boolean equals (Object obj)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getDnsServers

Added in API level 21
List<InetAddress> getDnsServers ()

Returns all the InetAddress for DNS servers on this link.

Returns
List<InetAddress> An umodifiable List of InetAddress for DNS servers on this link.

getDomains

Added in API level 21
String getDomains ()

Get the DNS domains search path set for this link.

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

getHttpProxy

Added in API level 21
ProxyInfo getHttpProxy ()

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

Returns
ProxyInfo The ProxyInfo set on this link

getInterfaceName

Added in API level 21
String getInterfaceName ()

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

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

getLinkAddresses

Added in API level 21
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
List<LinkAddress> An unmodifiable List of LinkAddress for this link.

getRoutes

Added in API level 21
List<RouteInfo> getRoutes ()

Returns all the RouteInfo set on this link.

Returns
List<RouteInfo> An unmodifiable List of RouteInfo for this link.

hashCode

Added in API level 21
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(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 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
int a hash code value for this object.

toString

Added in API level 21
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Returns
String a string representation of the object.

writeToParcel

Added in API level 21
void writeToParcel (Parcel dest, 
                int flags)

Implement the Parcelable interface.

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

Hooray!