com.github.robtimus.net.ip

Class IPv6Address

java.lang.Object

com.github.robtimus.net.ip.IPAddress<IPv6Address>

com.github.robtimus.net.ip.IPv6Address

All Implemented Interfaces:

Comparable<IPv6Address>

public final class IPv6Address
extends IPAddress<IPv6Address>

Represents an IPv6 address. Immutable.

Author:

Rob Spoor

Field Summary

Fields

Modifier and Type	Field and Description
static IPv6Address	LOCALHOST An IPv6 address object for localhost, ::1.
static IPv6Address	MAX_VALUE The maximum IPv6 address object, ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff.
static IPv6Address	MIN_VALUE The minimum IPv6 address object, ::.

Method Summary

Modifier and Type	Method and Description
IPv6Range	asRange() Returns an IP range containing only this IP address.
int	bits() Returns the number of bits required to store the IP address, always 128.
int	compareTo(IPv6Address other)
boolean	equals(Object o) Tests whether or not another object is equal to this IP address.
int	hashCode() Returns a hash code value for this IP address.
boolean	hasNext() Returns whether or not there is a next IP address.
boolean	hasPrevious() Returns whether or not there is a previous IP address.
static Predicate<CharSequence>	ifValidIPv6Address(Predicate<? super IPv6Address> predicate) Returns a predicate that checks whether or not CharSequences are valid IPv6 addresses that match a specific predicate.
IPv6Subnet	inSubnet(int prefixLength) Returns a subnet of a specific prefix length that contains this IP address.
boolean	isIPv4Mapped() Returns whether or not this IPv6 address is an IPv4 mapped address.
static boolean	isIPv6Address(CharSequence s) Tests whether or not a CharSequence is a valid IPv6 address.
static boolean	isIPv6Address(CharSequence s, int start, int end) Tests whether or not a portion of a CharSequence is a valid IPv6 address.
boolean	isLinkLocalAddress() Returns whether or not this IP address is a link local address.
boolean	isLoopbackAddress() Returns whether or not this IP address is a loopback address.
boolean	isMulticastAddress() Returns whether or not this IP address is an IP multicast address.
boolean	isSiteLocalAddress() Returns whether or not this IP address is a site local address.
boolean	isWildcardAddress() Returns whether or not this IP address is a wildcard address.
IPv6Address	next() Returns the next IP address if it exists.
IPv6Address	previous() Returns the previous IP address if it exists.
IPv6Range	to(IPv6Address end) Returns an IP range starting at this IP address and ending in another IP address.
byte[]	toByteArray() Returns a byte array representation of this IP address.
IPv4Address	toIPv4() Returns an IPv4 representation of this IPv6 address if it is an IPv4 mapped address.
static Optional<IPv6Address>	tryValueOfIPv6(CharSequence address) Attempts to return an IPv6 address represented by a CharSequence.
static Optional<IPv6Address>	tryValueOfIPv6(CharSequence address, int start, int end) Attempts to return an IPv6 address represented by a portion of a CharSequence.
static IPv6Address	valueOf(byte[] address) Returns an IPv6 address from a byte array representation of the address.
static IPv6Address	valueOf(CharSequence address) Returns an IPv6 address represented by a CharSequence.
static IPv6Address	valueOf(CharSequence address, int start, int end) Returns an IPv6 address represented by a portion of a CharSequence.
static IPv6Address	valueOf(Inet6Address address) Returns an IPv6 address represented by a Inet6Address.
static IPv6Address	valueOf(int hextet1, int hextet2, int hextet3, int hextet4, int hextet5, int hextet6, int hextet7, int hextet8) Returns an IPv6 address from eight hextets.

Methods inherited from class com.github.robtimus.net.ip.IPAddress

ifValidIPAddress, isIPAddress, isIPAddress, toInetAddress, toString, tryValueOf, tryValueOf, valueOf

Methods inherited from class java.lang.Object

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

Field Detail

LOCALHOST

public static final IPv6Address LOCALHOST

An IPv6 address object for localhost, ::1.

MIN_VALUE

public static final IPv6Address MIN_VALUE

The minimum IPv6 address object, ::.

MAX_VALUE

public static final IPv6Address MAX_VALUE

The maximum IPv6 address object, ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff.

Method Detail

bits

public int bits()

Returns the number of bits required to store the IP address, always 128.

Specified by:

bits in class IPAddress<IPv6Address>

Returns:

The number of bits required to store the IP address.

toByteArray

public byte[] toByteArray()

Description copied from class: IPAddress

Returns a byte array representation of this IP address. Its size is equal to IPAddress.bits() divided by Byte.SIZE. Furthermore, the result is in network byte order; the highest order byte is in the first element.

Specified by:

toByteArray in class IPAddress<IPv6Address>

Returns:

A byte array representation of this IP address.

toIPv4

public IPv4Address toIPv4()

Returns an IPv4 representation of this IPv6 address if it is an IPv4 mapped address. This IPv4 address is equivalent to d.d.d.d if this IPv6 address is ::ffff:d.d.d.d.

Returns:

An IPv4 representation of this IPv6 address.

Throws:

IllegalStateException - If this IPv6 address is not an IPv4 mapped address.

See Also:

isIPv4Mapped()

isIPv4Mapped

public boolean isIPv4Mapped()

Returns whether or not this IPv6 address is an IPv4 mapped address. An IPv6 address is an IPv4 mapped address if it's in the ::ffff:0:0/96 subnet (from ::ffff:0:0 to ::ffff:ffff:ffff).

Returns:

true if this IPv6 address is an IPv4 mapped address, or false otherwise.

equals

public boolean equals(Object o)

Description copied from class: IPAddress

Tests whether or not another object is equal to this IP address. An object is equal if it is a IP address with an equal return value of IPAddress.toByteArray().

Implementations do not necessary need to use IPAddress.toByteArray(), as long as equal IP addresses also have equal byte array representations.

Specified by:

equals in class IPAddress<IPv6Address>

hashCode

public int hashCode()

Description copied from class: IPAddress

Returns a hash code value for this IP address.

Implementations do not necessarily need to use IPAddress.toByteArray(), as long as the general contract as specified by Object.hashCode() is not violated.

Specified by:

hashCode in class IPAddress<IPv6Address>

compareTo

public int compareTo(IPv6Address other)

isMulticastAddress

public boolean isMulticastAddress()

Returns whether or not this IP address is an IP multicast address. This method returns whether or not the IP address is in subnet ff00::/8.

Specified by:

isMulticastAddress in class IPAddress<IPv6Address>

Returns:

true if this IP address is an IP multicast address, or false otherwise.

See Also:

Inet6Address.isMulticastAddress()

isWildcardAddress

public boolean isWildcardAddress()

Returns whether or not this IP address is a wildcard address.

Specified by:

isWildcardAddress in class IPAddress<IPv6Address>

Returns:

true if this IP address is a wildcard address, or false otherwise.

See Also:

Inet6Address.isAnyLocalAddress()

isLoopbackAddress

public boolean isLoopbackAddress()

Returns whether or not this IP address is a loopback address.

Specified by:

isLoopbackAddress in class IPAddress<IPv6Address>

Returns:

true if this IP address is a loopback address, or false otherwise.

See Also:

Inet6Address.isLoopbackAddress()

isLinkLocalAddress

public boolean isLinkLocalAddress()

Returns whether or not this IP address is a link local address. This method returns whether or not the IP address is in the fe80::/10 subnet.

Specified by:

isLinkLocalAddress in class IPAddress<IPv6Address>

Returns:

true if this IP address is a link local address, or false otherwise.

See Also:

Inet6Address.isLinkLocalAddress()

isSiteLocalAddress

public boolean isSiteLocalAddress()

Returns whether or not this IP address is a site local address. This method returns whether or not the IP address is in the fec0::/10 subnets.

Specified by:

isSiteLocalAddress in class IPAddress<IPv6Address>

Returns:

true if this IP address is a site local address, or false otherwise.

See Also:

Inet6Address.isSiteLocalAddress()

hasNext

public boolean hasNext()

Description copied from class: IPAddress

Returns whether or not there is a next IP address.

Specified by:

hasNext in class IPAddress<IPv6Address>

Returns:

true if there is a next IP address, or false otherwise.

next

public IPv6Address next()

Description copied from class: IPAddress

Returns the next IP address if it exists.

Specified by:

next in class IPAddress<IPv6Address>

Returns:

The next IP address.

See Also:

IPAddress.hasNext()

hasPrevious

public boolean hasPrevious()

Description copied from class: IPAddress

Returns whether or not there is a previous IP address.

Specified by:

hasPrevious in class IPAddress<IPv6Address>

Returns:

true if there is a previous IP address, or false otherwise.

previous

public IPv6Address previous()

Description copied from class: IPAddress

Returns the previous IP address if it exists.

Specified by:

previous in class IPAddress<IPv6Address>

Returns:

The previous IP address.

See Also:

IPAddress.hasPrevious()

to

public IPv6Range to(IPv6Address end)

Description copied from class: IPAddress

Returns an IP range starting at this IP address and ending in another IP address.

Specified by:

to in class IPAddress<IPv6Address>

Parameters:

end - The end of the IP range, inclusive.

Returns:

An IP range from this IP address to the given IP address.

asRange

public IPv6Range asRange()

Description copied from class: IPAddress

Returns an IP range containing only this IP address.

Specified by:

asRange in class IPAddress<IPv6Address>

Returns:

An IP range containing only this IP address.

inSubnet

public IPv6Subnet inSubnet(int prefixLength)

Description copied from class: IPAddress

Returns a subnet of a specific prefix length that contains this IP address.

Specified by:

inSubnet in class IPAddress<IPv6Address>

Parameters:

prefixLength - The prefix length of the subnet to return.

Returns:

A subnet of the given prefix length that contains this IP address.

valueOf

public static IPv6Address valueOf(int hextet1,
                                  int hextet2,
                                  int hextet3,
                                  int hextet4,
                                  int hextet5,
                                  int hextet6,
                                  int hextet7,
                                  int hextet8)

Returns an IPv6 address from eight hextets. For example, valueOf(0xFF, 0xAB, 0, 0, 0, 0, 0, 1) will return an IPv6 address that represents ff:ab::1.

Parameters:

hextet1 - The first hextet.

hextet2 - The second hextet.

hextet3 - The third hextet.

hextet4 - The fourth hextet.

hextet5 - The fifth hextet.

hextet6 - The sixth hextet.

hextet7 - The seventh hextet.

hextet8 - The eighth hextet.

Returns:

An IPv6 address that represents the given hextets.

Throws:

IllegalArgumentException - If any of the octets is not between 0 and 0xFFFF, inclusive.

valueOf

public static IPv6Address valueOf(byte[] address)

Returns an IPv6 address from a byte array representation of the address.

Parameters:

address - The array to return an IPv6 address for.

Returns:

An IPv6 address that represents the given array.

Throws:

NullPointerException - If the given array is null.

IllegalArgumentException - If the length of the given array is not 16.

valueOf

public static IPv6Address valueOf(CharSequence address)

Returns an IPv6 address represented by a CharSequence.

Parameters:

address - The IPv6 address as a CharSequence.

Returns:

An IPv6 address that represents the given address.

Throws:

NullPointerException - If the given CharSequence is null.

IllegalArgumentException - If the given CharSequence does not represent a valid IPv6 address.

valueOf

public static IPv6Address valueOf(CharSequence address,
                                  int start,
                                  int end)

Returns an IPv6 address represented by a portion of a CharSequence.

Parameters:

address - The IPv6 address as a CharSequence.

start - The index in the CharSequence where the IPv6 address starts, inclusive.

end - The index in the CharSequence where the IPv6 address ends, exclusive.

Returns:

An IPv6 address that represents the given address.

Throws:

NullPointerException - If the given CharSequence is null.

IndexOutOfBoundsException - If the start index is negative, or if the end index is larger than the length of the CharSequence, or if the start index is larger than the end index.

IllegalArgumentException - If the given CharSequence does not represent a valid IPv6 address.

Since:

1.1

tryValueOfIPv6

public static Optional<IPv6Address> tryValueOfIPv6(CharSequence address)

Attempts to return an IPv6 address represented by a CharSequence.

Parameters:

address - The possible IPv6 address as a CharSequence.

Returns:

An Optional with the IPv6 address that represents the given address, or Optional.empty() if the given CharSequence is nullor does not represent a valid IPv6 address.

tryValueOfIPv6

public static Optional<IPv6Address> tryValueOfIPv6(CharSequence address,
                                                   int start,
                                                   int end)

Attempts to return an IPv6 address represented by a portion of a CharSequence.

Parameters:

address - The possible IPv6 address as a CharSequence.

start - The index in the CharSequence where the IPv6 address starts, inclusive.

end - The index in the CharSequence where the IPv6 address ends, exclusive.

Returns:

An Optional with the IPv6 address that represents the given address, or Optional.empty() if the given CharSequence is nullor does not represent a valid IPv6 address.

Throws:

IndexOutOfBoundsException - If the start index is negative, or if the end index is larger than the length of the CharSequence, or if the start index is larger than the end index (unless if the CharSequence is null).

Since:

1.1

valueOf

public static IPv6Address valueOf(Inet6Address address)

Returns an IPv6 address represented by a Inet6Address.

Parameters:

address - The IPv6 address as a Inet6Address.

Returns:

An IPv6 address that represents the given address.

Throws:

NullPointerException - If the given Inet6Address is null.

isIPv6Address

public static boolean isIPv6Address(CharSequence s)

Tests whether or not a CharSequence is a valid IPv6 address.

Parameters:

s - The CharSequence to test.

Returns:

true if the given CharSequence is a valid IPv6 address, or false otherwise.

isIPv6Address

public static boolean isIPv6Address(CharSequence s,
                                    int start,
                                    int end)

Tests whether or not a portion of a CharSequence is a valid IPv6 address.

Parameters:

s - The CharSequence to test.

start - The index in the CharSequence to start checking at, inclusive.

end - The index in the CharSequence to end checking at, exclusive.

Returns:

true if the given CharSequence is a valid IPv6 address, or false otherwise.

Throws:

IndexOutOfBoundsException - If the start index is negative, or if the end index is larger than the length of the CharSequence, or if the start index is larger than the end index (unless if the CharSequence is null).

Since:

1.1

ifValidIPv6Address

public static Predicate<CharSequence> ifValidIPv6Address(Predicate<? super IPv6Address> predicate)

Returns a predicate that checks whether or not CharSequences are valid IPv6 addresses that match a specific predicate. This predicate can handle null values, which do not match the predicate.

Parameters:

predicate - The predicate to check if CharSequences are valid IP addresses.

Returns:

A predicate that checks whether or not CharSequences are valid IP addresses that match the given predicate.

See Also:

isIPv6Address(CharSequence)