Module com.aoapps.net.types

Package com.aoapps.net

Class InetAddress

java.lang.Object

com.aoapps.net.InetAddress

All Implemented Interfaces:

DtoFactory<InetAddress>, Internable<InetAddress>, Serializable, Comparable<InetAddress>

public final class InetAddress
extends Object
implements Comparable<InetAddress>, Serializable, DtoFactory<InetAddress>, Internable<InetAddress>

Represents either an IPv4 or an IPv6 IP address.

The internal storage is always that of an IPv6 address. IPv4 addresses are stored as IPv4-mapped addresses (::ffff:a.b.c.d), but their external representation is always dotted-decimal IPv4 notation (a.b.c.d).

• https://wikipedia.org/wiki/IPv4#Address_representations
• https://wikipedia.org/wiki/IPv6_Addresses#Notation

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final InetAddress	LOOPBACK_IPV4
static final InetAddress	LOOPBACK_IPV6
static final InetAddress	UNSPECIFIED_IPV4
static final InetAddress	UNSPECIFIED_IPV6

Method Summary

Modifier and Type	Method	Description
int	compareTo(InetAddress other)	Sorts by address family then numeric address.
boolean	equals(Object obj)
AddressFamily	getAddressFamily()	Deprecated. Please use getProtocolFamily() as of Java 1.7.
AddressType	getAddressType()	Gets the type for this address.
InetAddress	getDto()
long	getHigh()	Gets the high-order 64 bits of the numeric address.
LongLong	getIp()	Gets the numeric address as a 128-bit integer.
long	getLow()	Gets the low-order 64 bits of the numeric address.
ProtocolFamily	getProtocolFamily()
int	hashCode()
InetAddress	intern()	Interns this IP much in the same fashion as String.intern().
boolean	is6to4()
boolean	isBroadcast()	The IPv4 Broadcast (255.255.255.255/32).
boolean	isCarrierGradeNat()
boolean	isDocumentation()
boolean	isIPv4()	Deprecated. Please use getProtocolFamily()
boolean	isIPv6()	Deprecated. Please use getProtocolFamily()
boolean	isLinkLocal()
boolean	isLoopback()
boolean	isMulticast()
boolean	isNetworkBenchmark()
boolean	isOrchid()
boolean	isTeredo()
boolean	isUniqueLocal()
boolean	isUnspecified()
String	toBracketedString()	Gets an optionally-bracketed String representation of this IP address.
String	toString()	Converts this IP address to its String representation.
static ValidationResult	validate(String address)	Checks if the address is valid by calling parse(String) and discarding the result.
static InetAddress	valueOf(long hi, long lo)	Gets an IPv6 address from its numerical representation.
static InetAddress	valueOf(LongLong ip)	Gets an IPv6 address from its numerical representation.
static InetAddress	valueOf(String address)	Parses either an IPv4 or IPv6 address.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

UNSPECIFIED_IPV4

public static final InetAddress UNSPECIFIED_IPV4

UNSPECIFIED_IPV6

public static final InetAddress UNSPECIFIED_IPV6

LOOPBACK_IPV4

public static final InetAddress LOOPBACK_IPV4

LOOPBACK_IPV6

public static final InetAddress LOOPBACK_IPV6

Method Details

validate

public static ValidationResult validate(String address)

Checks if the address is valid by calling parse(String) and discarding the result.

When enclosed in brackets "[...]", will be parsed as an IPv6 InetAddress (see toBracketedString()).

See Also:

• parse(String)

valueOf

public static InetAddress valueOf(String address)
                           throws ValidationException

Parses either an IPv4 or IPv6 address.

When enclosed in brackets "[...]", will be parsed as an IPv6 InetAddress (see toBracketedString()).

Parameters:

address - when null, returns null

Throws:

ValidationException

valueOf

public static InetAddress valueOf(LongLong ip)

Gets an IPv6 address from its numerical representation.

Parameters:

ip - If ip is null, returns null.

See Also:

• valueOf(long, long)

valueOf

public static InetAddress valueOf(long hi,
 long lo)

Gets an IPv6 address from its numerical representation.

See Also:

• valueOf(com.aoapps.lang.math.LongLong)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(InetAddress other)

Sorts by address family then numeric address.

Specified by:

compareTo in interface Comparable<InetAddress>

toString

public String toString()

Converts this IP address to its String representation.

Overrides:

toString in class Object

toBracketedString

public String toBracketedString()

Gets an optionally-bracketed String representation of this IP address. If IPv6, the address is surrounded by [...]

intern

public InetAddress intern()

Interns this IP much in the same fashion as String.intern().

Specified by:

intern in interface Internable<InetAddress>

See Also:

• String.intern()

getHigh

public long getHigh()

Gets the high-order 64 bits of the numeric address.

See Also:

• getLow()
• getIp()

getLow

public long getLow()

Gets the low-order 64 bits of the numeric address.

See Also:

• getHigh()
• getIp()

getIp

public LongLong getIp()

Gets the numeric address as a 128-bit integer.

See Also:

• getHigh()
• getLow()

getDto

public InetAddress getDto()

Specified by:

getDto in interface DtoFactory<InetAddress>

isUnspecified

public boolean isUnspecified()

isLoopback

public boolean isLoopback()

See Also:

• LOOPBACK_IPV6
• InetAddressPrefixes.LOOPBACK_IPV4

isBroadcast

public boolean isBroadcast()

The IPv4 Broadcast (255.255.255.255/32).

See RFC 922, Section 7.

See Also:

• IPV4_BROADCAST_LO

isLinkLocal

public boolean isLinkLocal()

See Also:

• InetAddressPrefixes.LINK_LOCAL_IPV4
• InetAddressPrefixes.LINK_LOCAL_IPV6

isMulticast

public boolean isMulticast()

See Also:

• InetAddressPrefixes.MULTICAST_IPV4
• InetAddressPrefixes.MULTICAST_IPV6

isUniqueLocal

public boolean isUniqueLocal()

See Also:

• InetAddressPrefixes.UNIQUE_LOCAL_IPV4_8
• InetAddressPrefixes.UNIQUE_LOCAL_IPV4_12
• InetAddressPrefixes.UNIQUE_LOCAL_IPV4_16
• InetAddressPrefixes.UNIQUE_LOCAL_IPV6

is6to4

public boolean is6to4()

See Also:

• InetAddressPrefixes._6TO4_IPV4
• InetAddressPrefixes._6TO4_IPV6

isTeredo

public boolean isTeredo()

See Also:

• InetAddressPrefixes.TEREDO_IPV6

isDocumentation

public boolean isDocumentation()

See Also:

• InetAddressPrefixes.DOCUMENTATION_IPV4_1
• InetAddressPrefixes.DOCUMENTATION_IPV4_2
• InetAddressPrefixes.DOCUMENTATION_IPV4_3
• InetAddressPrefixes.DOCUMENTATION_IPV6

isNetworkBenchmark

public boolean isNetworkBenchmark()

See Also:

• InetAddressPrefixes.BENCHMARK_IPV4
• InetAddressPrefixes.BENCHMARK_IPV6

isOrchid

public boolean isOrchid()

See Also:

• InetAddressPrefixes.ORCHID_IPV6

isCarrierGradeNat

public boolean isCarrierGradeNat()

See Also:

• InetAddressPrefixes.CARRIER_GRADE_NAT_IPV4

getAddressFamily

@Deprecated
public AddressFamily getAddressFamily()

Deprecated.

Please use getProtocolFamily() as of Java 1.7.

getProtocolFamily

public ProtocolFamily getProtocolFamily()

getAddressType

public AddressType getAddressType()

Gets the type for this address.

isIPv4

@Deprecated
public boolean isIPv4()

Deprecated.

Please use getProtocolFamily()

isIPv6

@Deprecated
public boolean isIPv6()

Deprecated.

Please use getProtocolFamily()