FileDocCategorySizeDatePackage
InterfaceAddress.javaAPI DocJava SE 6 API3755Tue Jun 10 00:25:40 BST 2008java.net

InterfaceAddress

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.
see
java.net.NetworkInterface
since
1.6

Fields Summary
private InetAddress
address
private Inet4Address
broadcast
private short
maskLength
Constructors Summary
InterfaceAddress()


    /*
     * Package private constructor. Can't be built directly, instances are
     * obtained through the NetworkInterface class.
     */
     
    
Methods Summary
public booleanequals(java.lang.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.

param
obj the object to compare against.
return
true if the objects are the same; false otherwise.
see
java.net.InterfaceAddress#hashCode()

	if (!(obj instanceof InterfaceAddress)) {
	    return false;
	}
	InterfaceAddress cmp = (InterfaceAddress) obj;
	if ((address != null & cmp.address == null) ||
	    (!address.equals(cmp.address)))
	    return false;
	if ((broadcast != null & cmp.broadcast == null) ||
	    (!broadcast.equals(cmp.broadcast)))
	    return false;
	if (maskLength != cmp.maskLength)
	    return false;
	return true;
    
public java.net.InetAddressgetAddress()
Returns an InetAddress for this address.

return
the InetAddress for this address.

	return address;
    
public java.net.InetAddressgetBroadcast()
Returns an InetAddress for the brodcast address for this InterfaceAddress.

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

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

	return broadcast;
    
public shortgetNetworkPrefixLength()
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
a short representing the prefix length for the subnet of that address.

	return maskLength;
    
public inthashCode()
Returns a hashcode for this Interface address.

return
a hash code value for this Interface address.

	return address.hashCode() + ((broadcast != null) ? broadcast.hashCode() : 0) + maskLength;
    
public java.lang.StringtoString()
Converts this Interface address to a String. The string returned is of the form: InetAddress / prefix length [ broadcast address ].

return
a string representation of this Interface address.

	return address + "/" + maskLength + " [" + broadcast + "]";