java.net
Class Inet4Address

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.net.InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress 
      extended by java.net.Inet4Address
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public final class Inet4Address
extends InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress

This class represents an Internet Protocol version 4 (IPv4) address. Defined by RFC 790: Assigned Numbers, RFC 1918: Address Allocation for Private Internets, and RFC 2365: Administratively Scoped IP Multicast

Textual representation of IP addresses

Textual representation of IPv4 address used as input to methods takes one of the following forms:
d.d.d.d
d.d.d
d.d
d

When four parts are specified, each is interpreted as a byte of data and assigned, from left to right, to the four bytes of an IPv4 address.

When a three part address is specified, the last part is interpreted as a 16-bit quantity and placed in the right most two bytes of the network address. This makes the three part address format convenient for specifying Class B net- work addresses as 128.net.host.

When a two part address is supplied, the last part is interpreted as a 24-bit quantity and placed in the right most three bytes of the network address. This makes the two part address format convenient for specifying Class A network addresses as net.host.

When only one part is given, the value is stored directly in the network address without any byte rearrangement.

For methods that return a textual representation as output value, the first form, i.e. a dotted-quad string, is used.

The Scope of a Multicast Address

Historically the IPv4 TTL field in the IP header has doubled as a multicast scope field: a TTL of 0 means node-local, 1 means link-local, up through 32 means site-local, up through 64 means region-local, up through 128 means continent-local, and up through 255 are global. However, the administrative scoping is preferred. Please refer to RFC 2365: Administratively Scoped IP Multicast

See Also:
Serialized Form

Method Summary
 boolean equals sample code for java.net.Inet4Address.equals(java.lang.Object) definition code for java.net.Inet4Address.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Compares this object against the specified object.
 byte[] getAddress sample code for java.net.Inet4Address.getAddress() definition code for java.net.Inet4Address.getAddress() ()
          Returns the raw IP address of this InetAddress object.
 String sample code for java.lang.String definition code for java.lang.String getHostAddress sample code for java.net.Inet4Address.getHostAddress() definition code for java.net.Inet4Address.getHostAddress() ()
          Returns the IP address string in textual presentation form.
 int hashCode sample code for java.net.Inet4Address.hashCode() definition code for java.net.Inet4Address.hashCode() ()
          Returns a hashcode for this IP address.
 boolean isAnyLocalAddress sample code for java.net.Inet4Address.isAnyLocalAddress() definition code for java.net.Inet4Address.isAnyLocalAddress() ()
          Utility routine to check if the InetAddress in a wildcard address.
 boolean isLinkLocalAddress sample code for java.net.Inet4Address.isLinkLocalAddress() definition code for java.net.Inet4Address.isLinkLocalAddress() ()
          Utility routine to check if the InetAddress is an link local address.
 boolean isLoopbackAddress sample code for java.net.Inet4Address.isLoopbackAddress() definition code for java.net.Inet4Address.isLoopbackAddress() ()
          Utility routine to check if the InetAddress is a loopback address.
 boolean isMCGlobal sample code for java.net.Inet4Address.isMCGlobal() definition code for java.net.Inet4Address.isMCGlobal() ()
          Utility routine to check if the multicast address has global scope.
 boolean isMCLinkLocal sample code for java.net.Inet4Address.isMCLinkLocal() definition code for java.net.Inet4Address.isMCLinkLocal() ()
          Utility routine to check if the multicast address has link scope.
 boolean isMCNodeLocal sample code for java.net.Inet4Address.isMCNodeLocal() definition code for java.net.Inet4Address.isMCNodeLocal() ()
          Utility routine to check if the multicast address has node scope.
 boolean isMCOrgLocal sample code for java.net.Inet4Address.isMCOrgLocal() definition code for java.net.Inet4Address.isMCOrgLocal() ()
          Utility routine to check if the multicast address has organization scope.
 boolean isMCSiteLocal sample code for java.net.Inet4Address.isMCSiteLocal() definition code for java.net.Inet4Address.isMCSiteLocal() ()
          Utility routine to check if the multicast address has site scope.
 boolean isMulticastAddress sample code for java.net.Inet4Address.isMulticastAddress() definition code for java.net.Inet4Address.isMulticastAddress() ()
          Utility routine to check if the InetAddress is an IP multicast address.
 boolean isSiteLocalAddress sample code for java.net.Inet4Address.isSiteLocalAddress() definition code for java.net.Inet4Address.isSiteLocalAddress() ()
          Utility routine to check if the InetAddress is a site local address.
 
Methods inherited from class java.net.InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
getAllByName sample code for java.net.InetAddress.getAllByName(java.lang.String) definition code for java.net.InetAddress.getAllByName(java.lang.String) , getByAddress sample code for java.net.InetAddress.getByAddress(byte[]) definition code for java.net.InetAddress.getByAddress(byte[]) , getByAddress sample code for java.net.InetAddress.getByAddress(java.lang.String, byte[]) definition code for java.net.InetAddress.getByAddress(java.lang.String, byte[]) , getByName sample code for java.net.InetAddress.getByName(java.lang.String) definition code for java.net.InetAddress.getByName(java.lang.String) , getCanonicalHostName sample code for java.net.InetAddress.getCanonicalHostName() definition code for java.net.InetAddress.getCanonicalHostName() , getHostName sample code for java.net.InetAddress.getHostName() definition code for java.net.InetAddress.getHostName() , getLocalHost sample code for java.net.InetAddress.getLocalHost() definition code for java.net.InetAddress.getLocalHost() , isReachable sample code for java.net.InetAddress.isReachable(int) definition code for java.net.InetAddress.isReachable(int) , isReachable sample code for java.net.InetAddress.isReachable(java.net.NetworkInterface, int, int) definition code for java.net.InetAddress.isReachable(java.net.NetworkInterface, int, int) , toString sample code for java.net.InetAddress.toString() definition code for java.net.InetAddress.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Method Detail

isMulticastAddress sample code for java.net.Inet4Address.isMulticastAddress() definition code for java.net.Inet4Address.isMulticastAddress()

public boolean isMulticastAddress()
Utility routine to check if the InetAddress is an IP multicast address. IP multicast address is a Class D address i.e first four bits of the address are 1110.

Overrides:
isMulticastAddress sample code for java.net.InetAddress.isMulticastAddress() definition code for java.net.InetAddress.isMulticastAddress() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the InetAddress is an IP multicast address
Since:
JDK1.1

isAnyLocalAddress sample code for java.net.Inet4Address.isAnyLocalAddress() definition code for java.net.Inet4Address.isAnyLocalAddress()

public boolean isAnyLocalAddress()
Utility routine to check if the InetAddress in a wildcard address.

Overrides:
isAnyLocalAddress sample code for java.net.InetAddress.isAnyLocalAddress() definition code for java.net.InetAddress.isAnyLocalAddress() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the Inetaddress is a wildcard address.
Since:
1.4

isLoopbackAddress sample code for java.net.Inet4Address.isLoopbackAddress() definition code for java.net.Inet4Address.isLoopbackAddress()

public boolean isLoopbackAddress()
Description copied from class: InetAddress sample code for java.net.InetAddress.isLoopbackAddress() definition code for java.net.InetAddress.isLoopbackAddress()
Utility routine to check if the InetAddress is a loopback address.

Overrides:
isLoopbackAddress sample code for java.net.InetAddress.isLoopbackAddress() definition code for java.net.InetAddress.isLoopbackAddress() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the InetAddress is a loopback address; or false otherwise.

isLinkLocalAddress sample code for java.net.Inet4Address.isLinkLocalAddress() definition code for java.net.Inet4Address.isLinkLocalAddress()

public boolean isLinkLocalAddress()
Utility routine to check if the InetAddress is an link local address.

Overrides:
isLinkLocalAddress sample code for java.net.InetAddress.isLinkLocalAddress() definition code for java.net.InetAddress.isLinkLocalAddress() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the InetAddress is a link local address; or false if address is not a link local unicast address.
Since:
1.4

isSiteLocalAddress sample code for java.net.Inet4Address.isSiteLocalAddress() definition code for java.net.Inet4Address.isSiteLocalAddress()

public boolean isSiteLocalAddress()
Utility routine to check if the InetAddress is a site local address.

Overrides:
isSiteLocalAddress sample code for java.net.InetAddress.isSiteLocalAddress() definition code for java.net.InetAddress.isSiteLocalAddress() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the InetAddress is a site local address; or false if address is not a site local unicast address.
Since:
1.4

isMCGlobal sample code for java.net.Inet4Address.isMCGlobal() definition code for java.net.Inet4Address.isMCGlobal()

public boolean isMCGlobal()
Utility routine to check if the multicast address has global scope.

Overrides:
isMCGlobal sample code for java.net.InetAddress.isMCGlobal() definition code for java.net.InetAddress.isMCGlobal() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the address has is a multicast address of global scope, false if it is not of global scope or it is not a multicast address
Since:
1.4

isMCNodeLocal sample code for java.net.Inet4Address.isMCNodeLocal() definition code for java.net.Inet4Address.isMCNodeLocal()

public boolean isMCNodeLocal()
Utility routine to check if the multicast address has node scope.

Overrides:
isMCNodeLocal sample code for java.net.InetAddress.isMCNodeLocal() definition code for java.net.InetAddress.isMCNodeLocal() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the address has is a multicast address of node-local scope, false if it is not of node-local scope or it is not a multicast address
Since:
1.4

isMCLinkLocal sample code for java.net.Inet4Address.isMCLinkLocal() definition code for java.net.Inet4Address.isMCLinkLocal()

public boolean isMCLinkLocal()
Utility routine to check if the multicast address has link scope.

Overrides:
isMCLinkLocal sample code for java.net.InetAddress.isMCLinkLocal() definition code for java.net.InetAddress.isMCLinkLocal() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the address has is a multicast address of link-local scope, false if it is not of link-local scope or it is not a multicast address
Since:
1.4

isMCSiteLocal sample code for java.net.Inet4Address.isMCSiteLocal() definition code for java.net.Inet4Address.isMCSiteLocal()

public boolean isMCSiteLocal()
Utility routine to check if the multicast address has site scope.

Overrides:
isMCSiteLocal sample code for java.net.InetAddress.isMCSiteLocal() definition code for java.net.InetAddress.isMCSiteLocal() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the address has is a multicast address of site-local scope, false if it is not of site-local scope or it is not a multicast address
Since:
1.4

isMCOrgLocal sample code for java.net.Inet4Address.isMCOrgLocal() definition code for java.net.Inet4Address.isMCOrgLocal()

public boolean isMCOrgLocal()
Utility routine to check if the multicast address has organization scope.

Overrides:
isMCOrgLocal sample code for java.net.InetAddress.isMCOrgLocal() definition code for java.net.InetAddress.isMCOrgLocal() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a boolean indicating if the address has is a multicast address of organization-local scope, false if it is not of organization-local scope or it is not a multicast address
Since:
1.4

getAddress sample code for java.net.Inet4Address.getAddress() definition code for java.net.Inet4Address.getAddress()

public byte[] getAddress()
Returns the raw IP address of this InetAddress object. The result is in network byte order: the highest order byte of the address is in getAddress()[0].

Overrides:
getAddress sample code for java.net.InetAddress.getAddress() definition code for java.net.InetAddress.getAddress() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
the raw IP address of this object.

getHostAddress sample code for java.net.Inet4Address.getHostAddress() definition code for java.net.Inet4Address.getHostAddress()

public String sample code for java.lang.String definition code for java.lang.String  getHostAddress()
Returns the IP address string in textual presentation form.

Overrides:
getHostAddress sample code for java.net.InetAddress.getHostAddress() definition code for java.net.InetAddress.getHostAddress() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
the raw IP address in a string format.
Since:
JDK1.0.2

hashCode sample code for java.net.Inet4Address.hashCode() definition code for java.net.Inet4Address.hashCode()

public int hashCode()
Returns a hashcode for this IP address.

Overrides:
hashCode sample code for java.net.InetAddress.hashCode() definition code for java.net.InetAddress.hashCode() in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Returns:
a hash code value for this IP address.
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

equals sample code for java.net.Inet4Address.equals(java.lang.Object) definition code for java.net.Inet4Address.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for 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 IP address as this object.

Two instances of InetAddress represent the same IP address if the length of the byte arrays returned by getAddress is the same for both, and each of the array components is the same for the byte arrays.

Overrides:
equals sample code for java.net.InetAddress.equals(java.lang.Object) definition code for java.net.InetAddress.equals(java.lang.Object) in class InetAddress sample code for java.net.InetAddress definition code for java.net.InetAddress
Parameters:
obj - the object to compare against.
Returns:
true if the objects are the same; false otherwise.
See Also:
InetAddress.getAddress() sample code for java.net.InetAddress.getAddress() definition code for java.net.InetAddress.getAddress()