Added in API level 9

InterfaceAddress

open class InterfaceAddress
kotlin.Any
   ↳ java.net.InterfaceAddress

This class represents a Network Interface address. In short it's an IP address, a subnet mask and a broadcast address when the address is an IPv4 one. An IP address and a network prefix length in the case of IPv6 address.

Summary

Public methods
open Boolean
equals(other: Any?)

Compares this object against the specified object.
open InetAddress!

Returns an InetAddress for this address.
open InetAddress!

Returns an InetAddress for the broadcast address for this InterfaceAddress.
open Short

Returns the network prefix length for this address.
open Int

Returns a hashcode for this Interface address.
open String

Converts this Interface address to a String.

Public methods

equals

Added in API level 9
open fun equals(other: Any?): Boolean

Compares this object against the specified object. The result is true if and only if the argument is not null and it represents the same interface address as this object.

Two instances of InterfaceAddress represent the same address if the InetAddress, the prefix length and the broadcast are the same for both.

Parameters
obj the object to compare against.
Return
Boolean true if the objects are the same; false otherwise.

getAddress

Added in API level 9
open fun getAddress(): InetAddress!

Returns an InetAddress for this address.

Return
InetAddress! the InetAddress for this address.

getBroadcast

Added in API level 9
open fun getBroadcast(): InetAddress!

Returns an InetAddress for the broadcast address for this InterfaceAddress.

Only IPv4 networks have broadcast address therefore, in the case of an IPv6 network, null will be returned.

Return
InetAddress! the InetAddress representing the broadcast address or null if there is no broadcast address.

getNetworkPrefixLength

Added in API level 9
open fun getNetworkPrefixLength(): Short

Returns the network prefix length for this address. This is also known as the subnet mask in the context of IPv4 addresses. Typical IPv4 values would be 8 (255.0.0.0), 16 (255.255.0.0) or 24 (255.255.255.0).

Typical IPv6 values would be 128 (::1/128) or 10 (fe80::203:baff:fe27:1243/10)

Return
Short a short representing the prefix length for the subnet of that address.

hashCode

Added in API level 9
open fun hashCode(): Int

Returns a hashcode for this Interface address.

Return
Int a hash code value for this Interface address.

toString

Added in API level 9
open fun toString(): String

Converts this Interface address to a String. The string returned is of the form: InetAddress / prefix length [ broadcast address ].

Return
String a string representation of this Interface address.