InterfaceAddress | API reference

public class InterfaceAddress
extends Object

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
`boolean`	`equals(Object obj)` Compares this object against the specified object.
`InetAddress`	`getAddress()` Returns an `InetAddress` for this address.
`InetAddress`	`getBroadcast()` Returns an `InetAddress` for the broadcast address for this InterfaceAddress.
`short`	`getNetworkPrefixLength()` Returns the network prefix length for this address.
`int`	`hashCode()` Returns a hashcode for this Interface address.
`String`	`toString()` Converts this Interface address to a `String`.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

equals

public boolean equals (Object obj)

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`	`Object`: the object to compare against.

Returns
`boolean`	`true` if the objects are the same; `false` otherwise.

getAddress

public InetAddress getAddress ()

Returns an InetAddress for this address.

Returns
`InetAddress`	the `InetAddress` for this address.

getBroadcast

public InetAddress getBroadcast ()

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.

Returns
`InetAddress`	the `InetAddress` representing the broadcast address or `null` if there is no broadcast address.

getNetworkPrefixLength

public short getNetworkPrefixLength ()

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)

Returns
`short`	a `short` representing the prefix length for the subnet of that address.

hashCode

public int hashCode ()

Returns a hashcode for this Interface address.

Returns
`int`	a hash code value for this Interface address.

toString

public String toString ()

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

Returns
`String`	a string representation of this Interface address.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.