Top Description Inners Fields Constructors Methods
com.google.common.net

public final Class InetAddresses

extends Object
Class Inheritance
Annotations
@J2ktIncompatible
@GwtIncompatible
@ElementTypesAreNonnullByDefault
Static Imports
com.google.common.base.Preconditions.checkArgument, .Preconditions.checkNotNull, java.util.Objects.requireNonNull
Static utility methods pertaining to InetAddress instances.

Important Note

Unlike InetAddress.getByName(), the methods of this class never cause DNS services to be accessed. For this reason, you should prefer these methods as much as possible over their JDK equivalents whenever you are expecting to handle only IP address string literals -- there is no blocking DNS penalty for a malformed string.

When dealing with Inet4Address and Inet6Address objects as byte arrays (vis. InetAddress.getAddress()) they are 4 and 16 bytes in length, respectively, and represent the address in network byte order.

Examples of IP addresses and their byte representations:

The IPv4 loopback address, "127.0.0.1".
7f 00 00 01
The IPv6 loopback address, "::1".
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01
From the IPv6 reserved documentation prefix (2001:db8::/32), "2001:db8::1".
20 01 0d b8 00 00 00 00 00 00 00 00 00 00 00 01
An IPv6 "IPv4 compatible" (or "compat") address, "::192.168.0.1".
00 00 00 00 00 00 00 00 00 00 00 00 c0 a8 00 01
An IPv6 "IPv4 mapped" address, "::ffff:192.168.0.1".
00 00 00 00 00 00 00 00 00 00 ff ff c0 a8 00 01

A few notes about IPv6 "IPv4 mapped" addresses and their observed use in Java.

"IPv4 mapped" addresses were originally a representation of IPv4 addresses for use on an IPv6 socket that could receive both IPv4 and IPv6 connections (by disabling the IPV6_V6ONLY socket option on an IPv6 socket). Yes, it's confusing. Nevertheless, these "mapped" addresses were never supposed to be seen on the wire. That assumption was dropped, some say mistakenly, in later RFCs with the apparent aim of making IPv4-to-IPv6 transition simpler.

Technically one can create a 128bit IPv6 address with the wire format of a "mapped" address, as shown above, and transmit it in an IPv6 packet header. However, Java's InetAddress creation methods appear to adhere doggedly to the original intent of the "mapped" address: all "mapped" addresses return Inet4Address objects.

For added safety, it is common for IPv6 network operators to filter all packets where either the source or destination address appears to be a "compat" or "mapped" address. Filtering suggestions usually recommend discarding any packets with source or destination addresses in the invalid range ::/3, which includes both of these bizarre address formats. For more information on "bogons", including lists of IPv6 bogon space, see:

Author
Erik Kline
Since
5.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
InetAddresses.TeredoInfo

A simple immutable data class to encapsulate the information to be found in a Teredo address.

Field Summary

Modifier and TypeField and Description
private static final Inet4Address
ANY4

private static final char
IPV4_DELIMITER

private static final CharMatcher
IPV4_DELIMITER_MATCHER

private static final int
IPV4_PART_COUNT

private static final char
IPV6_DELIMITER

private static final CharMatcher
IPV6_DELIMITER_MATCHER

private static final int
IPV6_PART_COUNT

private static final Inet4Address
LOOPBACK4

Constructor Summary

AccessConstructor and Description
private
InetAddresses()

Method Summary

Modifier and TypeMethod and Description
private static InetAddress

Returns:

an InetAddress object created from the raw IP address
bytesToInetAddress(byte[]
the raw 4-byte or 16-byte IP address in big-endian order
addr)

Convert a byte array into an InetAddress.

public static int

Returns:

int, "coerced" if ip is not an IPv4 address
coerceToInteger(InetAddress
InetAddress to convert
ip)

Returns an integer representing an IPv4 address regardless of whether the supplied argument is an IPv4 address or not.

private static void
compressLongestRunOfZeroes(int[]
int[] mutable array of eight 16-bit hextets
hextets)

Identify and mark the longest run of zeroes in an IPv6 address.

private static String
convertDottedQuadToHex(String ipString)

public static InetAddress

Returns:

a new InetAddress that is one less than the passed in address
decrement(InetAddress
the InetAddress to decrement
address)

Returns a new InetAddress that is one less than the passed in address.

private static IllegalArgumentException
formatIllegalArgumentException(String format, Object... args)

public static InetAddress

Returns:

InetAddress representing the argument
forString(String
String containing an IPv4 or IPv6 string literal, e.g. "192.168.0.1" or "2001:db8::1"
ipString)

Returns the InetAddress having the given string representation.

public static InetAddress

Returns:

an InetAddress representing the address in hostAddr
forUriString(String
an RFC 3986 section 3.2.2 encoded IPv4 or IPv6 address
hostAddr)

Returns an InetAddress representing the literal IPv4 or IPv6 host portion of a URL, encoded in the format specified by RFC 3986 section 3.2.2.

private static InetAddress
forUriStringNoThrow(String hostAddr)

private static InetAddress

Returns:

the BigInteger converted to an address
fromBigInteger(BigInteger
the address represented as a big integer
address, boolean
whether the created address should be IPv4 or IPv6
isIpv6)

Converts a BigInteger to either an IPv4 or IPv6 address.

public static Inet4Address

Returns:

Inet4Address equivalent of the argument
fromInteger(int
int, the 32bit integer address to be converted
address)

Returns an Inet4Address having the integer value specified by the argument.

public static Inet4Address

Returns:

Inet4Address representation of the given BigInteger
fromIPv4BigInteger(BigInteger
BigInteger representing the IPv4 address
address)

Returns the Inet4Address corresponding to a given BigInteger.

public static Inet6Address

Returns:

Inet6Address representation of the given BigInteger
fromIPv6BigInteger(BigInteger
BigInteger representing the IPv6 address
address)

Returns the Inet6Address corresponding to a given BigInteger.

public static InetAddress

Returns:

an InetAddress object created from the raw IP address
fromLittleEndianByteArray(byte[]
the raw IP address in little-endian byte order
addr)

Returns an address from a little-endian ordered byte array (the opposite of what InetAddress#getByAddress expects).

public static Inet4Address

Returns:

Inet4Address of embedded IPv4 in 6to4 address
get6to4IPv4Address(Inet6Address
Inet6Address to be examined for embedded IPv4 in 6to4 address
ip)

Returns the IPv4 address embedded in a 6to4 address.

public static Inet4Address

Returns:

Inet4Address represented "coerced" address
getCoercedIPv4Address(InetAddress
InetAddress to "coerce"
ip)

Coerces an IPv6 address into an IPv4 address.

public static Inet4Address

Returns:

Inet4Address of the embedded IPv4 address
getCompatIPv4Address(Inet6Address
Inet6Address to be examined for an embedded IPv4 address
ip)

Returns the IPv4 address embedded in an IPv4 compatible address.

public static Inet4Address

Returns:

Inet4Address of embedded IPv4 client address
getEmbeddedIPv4ClientAddress(Inet6Address
Inet6Address to be examined for embedded IPv4 client address
ip)

Examines the Inet6Address to extract the embedded IPv4 client address if the InetAddress is an IPv6 address of one of the specified address types that contain an embedded IPv4 address.

private static Inet4Address

Returns:

Inet4Address corresponding to the supplied byte array
getInet4Address(byte[]
byte array representing an IPv4 address (should be of length 4)
bytes)

Returns an Inet4Address, given a byte array representation of the IPv4 address.

public static Inet4Address

Returns:

Inet4Address of embedded IPv4 in an ISATAP address
getIsatapIPv4Address(Inet6Address
Inet6Address to be examined for embedded IPv4 in ISATAP address
ip)

Returns the IPv4 address embedded in an ISATAP address.

public static InetAddresses.TeredoInfo

Returns:

extracted TeredoInfo
getTeredoInfo(Inet6Address
Inet6Address to be examined for embedded Teredo information
ip)

Returns the Teredo information embedded in a Teredo address.

public static boolean

Returns:

true if there is an embedded IPv4 client address
hasEmbeddedIPv4ClientAddress(Inet6Address
Inet6Address to be examined for embedded IPv4 client address
ip)

Examines the Inet6Address to determine if it is an IPv6 address of one of the specified address types that contain an embedded IPv4 address.

private static String
hextetsToIPv6String(int[]
int[] array of eight 16-bit hextets, or -1s
hextets)

Convert a list of hextets into a human-readable IPv6 address.

public static InetAddress

Returns:

a new InetAddress that is one more than the passed in address
increment(InetAddress
the InetAddress to increment
address)

Returns a new InetAddress that is one more than the passed in address.

private static byte[]
ipStringToBytes(String ipStringParam)

Returns null if unable to parse into a byte[].

public static boolean

Returns:

true if the argument is a 6to4 address
is6to4Address(Inet6Address
Inet6Address to be examined for 6to4 address format
ip)

Evaluates whether the argument is a 6to4 address.

public static boolean

Returns:

true if the argument is a valid "compat" address
isCompatIPv4Address(Inet6Address
Inet6Address to be examined for embedded IPv4 compatible address format
ip)

Evaluates whether the argument is an IPv6 "compat" address.

public static boolean

Returns:

true if the argument is a valid IP string literal
isInetAddress(String
String to evaluated as an IP string literal
ipString)

Returns true if the supplied string is a valid IP string literal, false otherwise.

public static boolean

Returns:

true if the argument is an ISATAP address
isIsatapAddress(Inet6Address
Inet6Address to be examined for ISATAP address format
ip)

Evaluates whether the argument is an ISATAP address.

public static boolean

Returns:

true if the argument is a valid "mapped" address
isMappedIPv4Address(String
String to be examined for embedded IPv4-mapped IPv6 address format
ipString)

Evaluates whether the argument is an "IPv4 mapped" IPv6 address.

public static boolean

Returns:

true if the InetAddress is either 255.255.255.255 for IPv4 or ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff for IPv6
isMaximum(InetAddress address)

Returns true if the InetAddress is either 255.255.255.255 for IPv4 or ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff for IPv6.

public static boolean

Returns:

true if the argument is a Teredo address
isTeredoAddress(Inet6Address
Inet6Address to be examined for Teredo address format
ip)

Evaluates whether the argument is a Teredo address.

public static boolean

Returns:

true if the argument is a valid IP URI host
isUriInetAddress(String
String to evaluated as an IP URI host string literal
ipString)

Returns true if the supplied string is a valid URI IP string literal, false otherwise.

private static short
parseHextet(String ipString, int start, int end)

private static byte
parseOctet(String ipString, int start, int end)

private static byte[]
textToNumericFormatV4(String ipString)

private static byte[]
textToNumericFormatV6(String ipString)

public static String

Returns:

String containing the text-formatted IP address
toAddrString(InetAddress
InetAddress to be converted to an address string
ip)

Returns the string representation of an InetAddress.

public static BigInteger

Returns:

BigInteger representation of the address
toBigInteger(InetAddress
InetAddress to convert
address)

Returns a BigInteger representing the address.

public static String

Returns:

String containing URI-safe string literal
toUriString(InetAddress
InetAddress to be converted to URI string literal
ip)

Returns the string representation of an InetAddress suitable for inclusion in a URI.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ANY4back to summary
private static final Inet4Address ANY4
IPV4_DELIMITERback to summary
private static final char IPV4_DELIMITER
IPV4_DELIMITER_MATCHERback to summary
private static final CharMatcher IPV4_DELIMITER_MATCHER
IPV4_PART_COUNTback to summary
private static final int IPV4_PART_COUNT
IPV6_DELIMITERback to summary
private static final char IPV6_DELIMITER
IPV6_DELIMITER_MATCHERback to summary
private static final CharMatcher IPV6_DELIMITER_MATCHER
IPV6_PART_COUNTback to summary
private static final int IPV6_PART_COUNT
LOOPBACK4back to summary
private static final Inet4Address LOOPBACK4

Constructor Detail

InetAddressesback to summary
private InetAddresses()

Method Detail

bytesToInetAddressback to summary
private static InetAddress bytesToInetAddress(byte[] addr)

Convert a byte array into an InetAddress.

InetAddress#getByAddress is documented as throwing a checked exception "if IP address is of illegal length." We replace it with an unchecked exception, for use by callers who already know that addr is an array of length 4 or 16.

Parameters
addr:byte[]

the raw 4-byte or 16-byte IP address in big-endian order

Returns:InetAddress

an InetAddress object created from the raw IP address

coerceToIntegerback to summary
public static int coerceToInteger(InetAddress ip)

Returns an integer representing an IPv4 address regardless of whether the supplied argument is an IPv4 address or not.

IPv6 addresses are coerced to IPv4 addresses before being converted to integers.

As long as there are applications that assume that all IP addresses are IPv4 addresses and can therefore be converted safely to integers (for whatever purpose) this function can be used to handle IPv6 addresses as well until the application is suitably fixed.

Note

an IPv6 address coerced to an IPv4 address can only be used for such purposes as rudimentary identification or indexing into a collection of real InetAddresses. They cannot be used as real addresses for the purposes of network communication.

Parameters
ip:InetAddress

InetAddress to convert

Returns:int

int, "coerced" if ip is not an IPv4 address

Since
7.0
compressLongestRunOfZeroesback to summary
private static void compressLongestRunOfZeroes(int[] hextets)

Identify and mark the longest run of zeroes in an IPv6 address.

Only runs of two or more hextets are considered. In case of a tie, the leftmost run wins. If a qualifying run is found, its hextets are replaced by the sentinel value -1.

Parameters
hextets:int[]

int[] mutable array of eight 16-bit hextets

convertDottedQuadToHexback to summary
private static String convertDottedQuadToHex(String ipString)
Annotations
@CheckForNull
decrementback to summary
public static InetAddress decrement(InetAddress address)

Returns a new InetAddress that is one less than the passed in address. This method works for both IPv4 and IPv6 addresses.

Parameters
address:InetAddress

the InetAddress to decrement

Returns:InetAddress

a new InetAddress that is one less than the passed in address

Exceptions
IllegalArgumentException:
if InetAddress is at the beginning of its range
Since
18.0
formatIllegalArgumentExceptionback to summary
private static IllegalArgumentException formatIllegalArgumentException(String format, Object... args)
forStringback to summary
public static InetAddress forString(String ipString)

Returns the InetAddress having the given string representation.

This deliberately avoids all nameservice lookups (e.g. no DNS).

Anything after a % in an IPv6 address is ignored (assumed to be a Scope ID).

This method accepts non-ASCII digits, for example "１９２.１６８.０.１" (those are fullwidth characters). That is consistent with InetAddress, but not with various RFCs. If you want to accept ASCII digits only, you can use something like CharMatcher.ascii().matchesAllOf(ipString).

Parameters
ipString:String

String containing an IPv4 or IPv6 string literal, e.g. "192.168.0.1" or "2001:db8::1"

Returns:InetAddress

InetAddress representing the argument

Annotations
@CanIgnoreReturnValue
Exceptions
IllegalArgumentException:
if the argument is not a valid IP string literal
forUriStringback to summary
public static InetAddress forUriString(String hostAddr)

Returns an InetAddress representing the literal IPv4 or IPv6 host portion of a URL, encoded in the format specified by RFC 3986 section 3.2.2.

This method is similar to InetAddresses#forString(String), however, it requires that IPv6 addresses are surrounded by square brackets.

This method is the inverse of InetAddresses#toUriString(java.net.InetAddress).

This method accepts non-ASCII digits, for example "１９２.１６８.０.１" (those are fullwidth characters). That is consistent with InetAddress, but not with various RFCs. If you want to accept ASCII digits only, you can use something like CharMatcher.ascii().matchesAllOf(ipString).

Parameters
hostAddr:String

an RFC 3986 section 3.2.2 encoded IPv4 or IPv6 address

Returns:InetAddress

an InetAddress representing the address in hostAddr

Exceptions
IllegalArgumentException:
if hostAddr is not a valid IPv4 address, or IPv6 address surrounded by square brackets
forUriStringNoThrowback to summary
private static InetAddress forUriStringNoThrow(String hostAddr)
Annotations
@CheckForNull
fromBigIntegerback to summary
private static InetAddress fromBigInteger(BigInteger address, boolean isIpv6)

Converts a BigInteger to either an IPv4 or IPv6 address. If the IP is IPv4, it must be constrained to 32 bits, otherwise it is constrained to 128 bits.

Parameters
address:BigInteger

the address represented as a big integer

isIpv6:boolean

whether the created address should be IPv4 or IPv6

Returns:InetAddress

the BigInteger converted to an address

Exceptions
IllegalArgumentException:
if the BigInteger is not between 0 and maximum value for IPv4 or IPv6 respectively
fromIntegerback to summary
public static Inet4Address fromInteger(int address)

Returns an Inet4Address having the integer value specified by the argument.

Parameters
address:int

int, the 32bit integer address to be converted

Returns:Inet4Address

Inet4Address equivalent of the argument

fromIPv4BigIntegerback to summary
public static Inet4Address fromIPv4BigInteger(BigInteger address)

Returns the Inet4Address corresponding to a given BigInteger.

Parameters
address:BigInteger

BigInteger representing the IPv4 address

Returns:Inet4Address

Inet4Address representation of the given BigInteger

Exceptions
IllegalArgumentException:
if the BigInteger is not between 0 and 2^32-1
Since
28.2
fromIPv6BigIntegerback to summary
public static Inet6Address fromIPv6BigInteger(BigInteger address)

Returns the Inet6Address corresponding to a given BigInteger.

Parameters
address:BigInteger

BigInteger representing the IPv6 address

Returns:Inet6Address

Inet6Address representation of the given BigInteger

Exceptions
IllegalArgumentException:
if the BigInteger is not between 0 and 2^128-1
Since
28.2
fromLittleEndianByteArrayback to summary
public static InetAddress fromLittleEndianByteArray(byte[] addr) throws UnknownHostException

Returns an address from a little-endian ordered byte array (the opposite of what InetAddress#getByAddress expects).

IPv4 address byte array must be 4 bytes long and IPv6 byte array must be 16 bytes long.

Parameters
addr:byte[]

the raw IP address in little-endian byte order

Returns:InetAddress

an InetAddress object created from the raw IP address

Exceptions
UnknownHostException:
if IP address is of illegal length
get6to4IPv4Addressback to summary
public static Inet4Address get6to4IPv4Address(Inet6Address ip)

Returns the IPv4 address embedded in a 6to4 address.

Parameters
ip:Inet6Address

Inet6Address to be examined for embedded IPv4 in 6to4 address

Returns:Inet4Address

Inet4Address of embedded IPv4 in 6to4 address

Exceptions
IllegalArgumentException:
if the argument is not a valid IPv6 6to4 address
getCoercedIPv4Addressback to summary
public static Inet4Address getCoercedIPv4Address(InetAddress ip)

Coerces an IPv6 address into an IPv4 address.

HACK: As long as applications continue to use IPv4 addresses for indexing into tables, accounting, et cetera, it may be necessary to coerce IPv6 addresses into IPv4 addresses. This method does so by hashing 64 bits of the IPv6 address into 224.0.0.0/3 (64 bits into 29 bits):

  • If the IPv6 address contains an embedded IPv4 address, the function hashes that.
  • Otherwise, it hashes the upper 64 bits of the IPv6 address.

A "coerced" IPv4 address is equivalent to itself.

Note

This method is failsafe for security purposes: ALL IPv6 addresses (except localhost (::1)) are hashed to avoid the security risk associated with extracting an embedded IPv4 address that might permit elevated privileges.

Parameters
ip:InetAddress

InetAddress to "coerce"

Returns:Inet4Address

Inet4Address represented "coerced" address

Since
7.0
getCompatIPv4Addressback to summary
public static Inet4Address getCompatIPv4Address(Inet6Address ip)

Returns the IPv4 address embedded in an IPv4 compatible address.

Parameters
ip:Inet6Address

Inet6Address to be examined for an embedded IPv4 address

Returns:Inet4Address

Inet4Address of the embedded IPv4 address

Exceptions
IllegalArgumentException:
if the argument is not a valid IPv4 compatible address
getEmbeddedIPv4ClientAddressback to summary
public static Inet4Address getEmbeddedIPv4ClientAddress(Inet6Address ip)

Examines the Inet6Address to extract the embedded IPv4 client address if the InetAddress is an IPv6 address of one of the specified address types that contain an embedded IPv4 address.

Note

ISATAP addresses are explicitly excluded from this method due to their trivial spoofability. With other transition addresses spoofing involves (at least) infection of one's BGP routing table.

Parameters
ip:Inet6Address

Inet6Address to be examined for embedded IPv4 client address

Returns:Inet4Address

Inet4Address of embedded IPv4 client address

Exceptions
IllegalArgumentException:
if the argument does not have a valid embedded IPv4 address
getInet4Addressback to summary
private static Inet4Address getInet4Address(byte[] bytes)

Returns an Inet4Address, given a byte array representation of the IPv4 address.

Parameters
bytes:byte[]

byte array representing an IPv4 address (should be of length 4)

Returns:Inet4Address

Inet4Address corresponding to the supplied byte array

Exceptions
IllegalArgumentException:
if a valid Inet4Address can not be created
getIsatapIPv4Addressback to summary
public static Inet4Address getIsatapIPv4Address(Inet6Address ip)

Returns the IPv4 address embedded in an ISATAP address.

Parameters
ip:Inet6Address

Inet6Address to be examined for embedded IPv4 in ISATAP address

Returns:Inet4Address

Inet4Address of embedded IPv4 in an ISATAP address

Exceptions
IllegalArgumentException:
if the argument is not a valid IPv6 ISATAP address
getTeredoInfoback to summary
public static InetAddresses.TeredoInfo getTeredoInfo(Inet6Address ip)

Returns the Teredo information embedded in a Teredo address.

Parameters
ip:Inet6Address

Inet6Address to be examined for embedded Teredo information

Returns:InetAddresses.TeredoInfo

extracted TeredoInfo

Exceptions
IllegalArgumentException:
if the argument is not a valid IPv6 Teredo address
hasEmbeddedIPv4ClientAddressback to summary
public static boolean hasEmbeddedIPv4ClientAddress(Inet6Address ip)

Examines the Inet6Address to determine if it is an IPv6 address of one of the specified address types that contain an embedded IPv4 address.

Note

ISATAP addresses are explicitly excluded from this method due to their trivial spoofability. With other transition addresses spoofing involves (at least) infection of one's BGP routing table.

Parameters
ip:Inet6Address

Inet6Address to be examined for embedded IPv4 client address

Returns:boolean

true if there is an embedded IPv4 client address

Since
7.0
hextetsToIPv6Stringback to summary
private static String hextetsToIPv6String(int[] hextets)

Convert a list of hextets into a human-readable IPv6 address.

In order for "::" compression to work, the input should contain negative sentinel values in place of the elided zeroes.

Parameters
hextets:int[]

int[] array of eight 16-bit hextets, or -1s

incrementback to summary
public static InetAddress increment(InetAddress address)

Returns a new InetAddress that is one more than the passed in address. This method works for both IPv4 and IPv6 addresses.

Parameters
address:InetAddress

the InetAddress to increment

Returns:InetAddress

a new InetAddress that is one more than the passed in address

Exceptions
IllegalArgumentException:
if InetAddress is at the end of its range
Since
10.0
ipStringToBytesback to summary
private static byte[] ipStringToBytes(String ipStringParam)

Returns null if unable to parse into a byte[].

Annotations
@CheckForNull
is6to4Addressback to summary
public static boolean is6to4Address(Inet6Address ip)

Evaluates whether the argument is a 6to4 address.

6to4 addresses begin with the "2002::/16" prefix. The next 32 bits are the IPv4 address of the host to which IPv6-in-IPv4 tunneled packets should be routed.

For more on 6to4 addresses see section 2 of RFC 3056.

Parameters
ip:Inet6Address

Inet6Address to be examined for 6to4 address format

Returns:boolean

true if the argument is a 6to4 address

isCompatIPv4Addressback to summary
public static boolean isCompatIPv4Address(Inet6Address ip)

Evaluates whether the argument is an IPv6 "compat" address.

An "IPv4 compatible", or "compat", address is one with 96 leading bits of zero, with the remaining 32 bits interpreted as an IPv4 address. These are conventionally represented in string literals as "::192.168.0.1", though "::c0a8:1" is also considered an IPv4 compatible address (and equivalent to "::192.168.0.1").

For more on IPv4 compatible addresses see section 2.5.5.1 of RFC 4291.

Note

This method is different from Inet6Address#isIPv4CompatibleAddress in that it more correctly classifies "::" and "::1" as proper IPv6 addresses (which they are), NOT IPv4 compatible addresses (which they are generally NOT considered to be).

Parameters
ip:Inet6Address

Inet6Address to be examined for embedded IPv4 compatible address format

Returns:boolean

true if the argument is a valid "compat" address

isInetAddressback to summary
public static boolean isInetAddress(String ipString)

Returns true if the supplied string is a valid IP string literal, false otherwise.

This method accepts non-ASCII digits, for example "１９２.１６８.０.１" (those are fullwidth characters). That is consistent with InetAddress, but not with various RFCs. If you want to accept ASCII digits only, you can use something like CharMatcher.ascii().matchesAllOf(ipString).

Parameters
ipString:String

String to evaluated as an IP string literal

Returns:boolean

true if the argument is a valid IP string literal

isIsatapAddressback to summary
public static boolean isIsatapAddress(Inet6Address ip)

Evaluates whether the argument is an ISATAP address.

From RFC 5214: "ISATAP interface identifiers are constructed in Modified EUI-64 format [...] by concatenating the 24-bit IANA OUI (00-00-5E), the 8-bit hexadecimal value 0xFE, and a 32-bit IPv4 address in network byte order [...]"

For more on ISATAP addresses see section 6.1 of RFC 5214.

Parameters
ip:Inet6Address

Inet6Address to be examined for ISATAP address format

Returns:boolean

true if the argument is an ISATAP address

isMappedIPv4Addressback to summary
public static boolean isMappedIPv4Address(String ipString)

Evaluates whether the argument is an "IPv4 mapped" IPv6 address.

An "IPv4 mapped" address is anything in the range ::ffff:0:0/96 (sometimes written as ::ffff:0.0.0.0/96), with the last 32 bits interpreted as an IPv4 address.

For more on IPv4 mapped addresses see section 2.5.5.2 of RFC 4291.

Note

This method takes a String argument because InetAddress automatically collapses mapped addresses to IPv4. (It is actually possible to avoid this using one of the obscure Inet6Address methods, but it would be unwise to depend on such a poorly-documented feature.)

This method accepts non-ASCII digits. That is consistent with InetAddress, but not with various RFCs. If you want to accept ASCII digits only, you can use something like CharMatcher.ascii().matchesAllOf(ipString).

Parameters
ipString:String

String to be examined for embedded IPv4-mapped IPv6 address format

Returns:boolean

true if the argument is a valid "mapped" address

Since
10.0
isMaximumback to summary
public static boolean isMaximum(InetAddress address)

Returns true if the InetAddress is either 255.255.255.255 for IPv4 or ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff for IPv6.

Returns:boolean

true if the InetAddress is either 255.255.255.255 for IPv4 or ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff for IPv6

Since
10.0
isTeredoAddressback to summary
public static boolean isTeredoAddress(Inet6Address ip)

Evaluates whether the argument is a Teredo address.

Teredo addresses begin with the "2001::/32" prefix.

Parameters
ip:Inet6Address

Inet6Address to be examined for Teredo address format

Returns:boolean

true if the argument is a Teredo address

isUriInetAddressback to summary
public static boolean isUriInetAddress(String ipString)

Returns true if the supplied string is a valid URI IP string literal, false otherwise.

This method accepts non-ASCII digits, for example "１９２.１６８.０.１" (those are fullwidth characters). That is consistent with InetAddress, but not with various RFCs. If you want to accept ASCII digits only, you can use something like CharMatcher.ascii().matchesAllOf(ipString).

Parameters
ipString:String

String to evaluated as an IP URI host string literal

Returns:boolean

true if the argument is a valid IP URI host

parseHextetback to summary
private static short parseHextet(String ipString, int start, int end)
parseOctetback to summary
private static byte parseOctet(String ipString, int start, int end)
textToNumericFormatV4back to summary
private static byte[] textToNumericFormatV4(String ipString)
Annotations
@CheckForNull
textToNumericFormatV6back to summary
private static byte[] textToNumericFormatV6(String ipString)
Annotations
@CheckForNull
toAddrStringback to summary
public static String toAddrString(InetAddress ip)

Returns the string representation of an InetAddress.

For IPv4 addresses, this is identical to InetAddress#getHostAddress(), but for IPv6 addresses, the output follows RFC 5952 section 4. The main difference is that this method uses "::" for zero compression, while Java's version uses the uncompressed form.

This method uses hexadecimal for all IPv6 addresses, including IPv4-mapped IPv6 addresses such as "::c000:201". The output does not include a Scope ID.

Parameters
ip:InetAddress

InetAddress to be converted to an address string

Returns:String

String containing the text-formatted IP address

Since
10.0
toBigIntegerback to summary
public static BigInteger toBigInteger(InetAddress address)

Returns a BigInteger representing the address.

Unlike coerceToInteger, IPv6 addresses are not coerced to IPv4 addresses.

Parameters
address:InetAddress

InetAddress to convert

Returns:BigInteger

BigInteger representation of the address

Since
28.2
toUriStringback to summary
public static String toUriString(InetAddress ip)

Returns the string representation of an InetAddress suitable for inclusion in a URI.

For IPv4 addresses, this is identical to InetAddress#getHostAddress(), but for IPv6 addresses it compresses zeroes and surrounds the text with square brackets; for example "[2001:db8::1]".

Per section 3.2.2 of RFC 3986, a URI containing an IPv6 string literal is of the form "http://[2001:db8::1]:8888/index.html".

Use of either InetAddresses#toAddrString, InetAddress#getHostAddress(), or this method is recommended over InetAddress#toString() when an IP address string literal is desired. This is because InetAddress#toString() prints the hostname and the IP address string joined by a "/".

Parameters
ip:InetAddress

InetAddress to be converted to URI string literal

Returns:String

String containing URI-safe string literal

com.google.common.net back to summary

public final Class InetAddresses.TeredoInfo

extends Object
Class Inheritance
A simple immutable data class to encapsulate the information to be found in a Teredo address.

All of the fields in this class are encoded in various portions of the IPv6 address as part of the protocol. More protocols details can be found at: http://en.wikipedia. org/wiki/Teredo_tunneling.

The RFC can be found here: RFC 4380.

Since
5.0

Field Summary

Modifier and TypeField and Description
private final Inet4Address
client

private final int
flags

private final int
port

private final Inet4Address
server

Constructor Summary

AccessConstructor and Description
public
TeredoInfo(Inet4Address server, Inet4Address client, int port, int flags)

Constructs a TeredoInfo instance.

Method Summary

Modifier and TypeMethod and Description
public Inet4Address
getClient()

public int
getFlags()

public int
getPort()

public Inet4Address
getServer()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

clientback to summary
private final Inet4Address client
flagsback to summary
private final int flags
portback to summary
private final int port
serverback to summary
private final Inet4Address server

Constructor Detail

TeredoInfoback to summary
public TeredoInfo(Inet4Address server, Inet4Address client, int port, int flags)

Constructs a TeredoInfo instance.

Both server and client can be null, in which case the value "0.0.0.0" will be assumed.

Exceptions
IllegalArgumentException:
if either of the port or the flags arguments are out of range of an unsigned short

Method Detail

getClientback to summary
public Inet4Address getClient()
getFlagsback to summary
public int getFlags()
getPortback to summary
public int getPort()
getServerback to summary
public Inet4Address getServer()