Android APIs
public final class

RouteInfo

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

Class Overview

Represents a network route.

This is used both to describe static network configuration and live network configuration information. A route contains three pieces of information:

  • a destination IpPrefix specifying the network destinations covered by this route. If this is null it indicates a default route of the address family (IPv4 or IPv6) implied by the gateway IP address.
  • a gateway InetAddress indicating the next hop to use. If this is null it indicates a directly-connected route.
  • an interface (which may be unspecified).
Either the destination or the gateway may be null, but not both. If the destination and gateway are both specified, they must be of the same address family (IPv4 or IPv6).

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<RouteInfo> CREATOR Implement the Parcelable interface.
Public Methods
int describeContents()
Implement the Parcelable interface
boolean equals(Object obj)
Compares this RouteInfo object against the specified object and indicates if they are equal.
IpPrefix getDestination()
Retrieves the destination address and prefix length in the form of an IpPrefix.
InetAddress getGateway()
Retrieves the gateway or next hop InetAddress for this route.
String getInterface()
Retrieves the interface used for this route if specified, else null.
int hashCode()
Returns a hashcode for this RouteInfo object.
boolean isDefaultRoute()
Indicates if this route is a default route (ie, has no destination specified).
boolean matches(InetAddress destination)
Determines whether the destination and prefix of this route includes the specified address.
String toString()
Returns a 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<RouteInfo> CREATOR

Added in API level 21

Implement the Parcelable interface.

Public Methods

public int describeContents ()

Added in API level 21

Implement the Parcelable interface

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

public boolean equals (Object obj)

Added in API level 21

Compares this RouteInfo object against the specified object and indicates if they are equal.

Parameters
obj the object to compare this instance with.
Returns
  • true if the objects are equal, false otherwise.

public IpPrefix getDestination ()

Added in API level 21

Retrieves the destination address and prefix length in the form of an IpPrefix.

Returns
  • IpPrefix specifying the destination. This is never null.

public InetAddress getGateway ()

Added in API level 21

Retrieves the gateway or next hop InetAddress for this route.

Returns
  • InetAddress specifying the gateway or next hop. This may be null for a directly-connected route."

public String getInterface ()

Added in API level 21

Retrieves the interface used for this route if specified, else null.

Returns
  • The name of the interface used for this route.

public int hashCode ()

Added in API level 21

Returns a hashcode for this RouteInfo object.

Returns
  • this object's hash code.

public boolean isDefaultRoute ()

Added in API level 21

Indicates if this route is a default route (ie, has no destination specified).

Returns
  • true if the destination has a prefix length of 0.

public boolean matches (InetAddress destination)

Added in API level 21

Determines whether the destination and prefix of this route includes the specified address.

Parameters
destination A InetAddress to test to see if it would match this route.
Returns
  • true if the destination and prefix length cover the given address.

public String toString ()

Added in API level 21

Returns a human-readable description of this object.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel dest, int flags)

Added in API level 21

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.