com.github.robtimus.net.ip

Class IPv6Subnet

java.lang.Object

com.github.robtimus.net.ip.AbstractIPRange<IP>

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

com.github.robtimus.net.ip.IPv6Subnet

All Implemented Interfaces:

IPRange<IPv6Address>, IPv6Range, Iterable<IPv6Address>, Collection<IPv6Address>

public final class IPv6Subnet
extends Subnet<IPv6Address>
implements IPv6Range

Represents a subnet of IPv6 addresses. Immutable.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
static boolean	isIPv6Subnet(CharSequence s) Tests whether or not a CharSequence is a valid IPv6 subnet.
static boolean	isIPv6Subnet(CharSequence s, int start, int end) Tests whether or not a portion of a CharSequence is a valid IPv6 subnet.
int	size() Returns the number of IP addresses in this IP range.
Spliterator<IPv6Address>	spliterator()
static Optional<IPv6Subnet>	tryValueOfIPv6(CharSequence cidrNotation) Attempts to return an IPv6 subnet represented by a CharSequence.
static Optional<IPv6Subnet>	tryValueOfIPv6(CharSequence cidrNotation, int start, int end) Attempts to return an IPv6 subnet represented by a portion of a CharSequence.
static IPv6Subnet	valueOf(CharSequence cidrNotation) Returns an IPv6 subnet represented by a CIDR notation.
static IPv6Subnet	valueOf(CharSequence routingPrefix, int prefixLength) Returns an IPv6 subnet represented by a routing prefix and a prefix length.
static IPv6Subnet	valueOf(CharSequence cidrNotation, int start, int end) Returns an IPv6 subnet represented by a CIDR notation.
static IPv6Subnet	valueOf(IPv6Address routingPrefix, int prefixLength) Returns an IPv6 subnet represented by a routing prefix and a prefix length.

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

from, isSubnet, isSubnet, prefixLength, routingPrefix, to, toString, tryValueOf, tryValueOf, valueOf

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

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.robtimus.net.ip.IPv6Range

all

Methods inherited from interface com.github.robtimus.net.ip.IPRange

add, addAll, clear, contains, contains, containsAll, equals, forEach, from, hashCode, isEmpty, iterator, remove, removeAll, removeIf, retainAll, to, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, stream

Method Detail

size

public int size()

Description copied from interface: IPRange

Returns the number of IP addresses in this IP range. This number must be at least 1.

Specified by:

size in interface IPRange<IPv6Address>

Specified by:

size in interface Collection<IPv6Address>

spliterator

public Spliterator<IPv6Address> spliterator()

Specified by:

spliterator in interface Iterable<IPv6Address>

Specified by:

spliterator in interface Collection<IPv6Address>

valueOf

public static IPv6Subnet valueOf(CharSequence cidrNotation)

Returns an IPv6 subnet represented by a CIDR notation.

Parameters:

cidrNotation - The CIDR notation representing the IPv6 subnet.

Returns:

An IPv6 subnet represented by the given CIDR notation.

Throws:

NullPointerException - If the given CIDR notation is null.

IllegalArgumentException - If the given CIDR notation is invalid.

valueOf

public static IPv6Subnet valueOf(CharSequence cidrNotation,
                                 int start,
                                 int end)

Returns an IPv6 subnet represented by a CIDR notation.

Parameters:

cidrNotation - The CIDR notation representing the IPv6 subnet.

start - The index in the CharSequence where the CIDR notation starts, inclusive.

end - The index in the CharSequence where the CIDR notation ends, exclusive.

Returns:

An IPv6 subnet represented by the given CIDR notation.

Throws:

NullPointerException - If the given CIDR notation 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 CIDR notation is invalid.

Since:

1.1

tryValueOfIPv6

public static Optional<IPv6Subnet> tryValueOfIPv6(CharSequence cidrNotation)

Attempts to return an IPv6 subnet represented by a CharSequence.

Parameters:

cidrNotation - The possible CIDR notation representing the IPv6 subnet.

Returns:

An Optional with the IPv6 subnet represented by the given CIDR notation, or Optional.empty() if the given CIDR notation is null or invalid.

tryValueOfIPv6

public static Optional<IPv6Subnet> tryValueOfIPv6(CharSequence cidrNotation,
                                                  int start,
                                                  int end)

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

Parameters:

cidrNotation - The possible CIDR notation representing the IPv6 subnet.

start - The index in the CharSequence where the CIDR notation starts, inclusive.

end - The index in the CharSequence where the CIDR notation ends, exclusive.

Returns:

An Optional with the IPv6 subnet represented by the given CIDR notation, or Optional.empty() if the given CIDR notation is null or invalid.

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 IPv6Subnet valueOf(IPv6Address routingPrefix,
                                 int prefixLength)

Returns an IPv6 subnet represented by a routing prefix and a prefix length. The given routing prefix must be the start of the IPv6 subnet of the given prefix length that contains the routing prefix. For example, ffff:ffff:: is valid for prefix length 32, but ffff:ffff::1 is not.

Parameters:

routingPrefix - The routing prefix of the IPv6 subnet.

prefixLength - The length of the prefix of the IPv6 subnet.

Returns:

An IPv6 subnet represented by the given routing prefix and prefix length.

Throws:

NullPointerException - If the given routing prefix is null.

IllegalArgumentException - If the given prefix length is not valid for the IP address, or if the given routing prefix is not the start of the IPv6 subnet of the given prefix length that contains the routing prefix.

valueOf

public static IPv6Subnet valueOf(CharSequence routingPrefix,
                                 int prefixLength)

Returns an IPv6 subnet represented by a routing prefix and a prefix length. The given routing prefix must be the start of the IPv6 subnet of the given prefix length that contains the routing prefix. For example, ffff:ffff:: is valid for prefix length 32, but ffff:ffff::1 is not.

Parameters:

routingPrefix - The routing prefix of the IPv6 subnet.

prefixLength - The length of the prefix of the IPv6 subnet.

Returns:

An IPv6 subnet represented by the given routing prefix and prefix length.

Throws:

NullPointerException - If the given routing prefix is null.

IllegalArgumentException - If the given routing prefix does not represent a valid IP address, or if the given prefix length is not valid for the IP address, or if the given routing prefix is not the start of the IPv6 subnet of the given prefix length that contains the routing prefix.

See Also:

valueOf(IPv6Address, int)

isIPv6Subnet

public static boolean isIPv6Subnet(CharSequence s)

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

Parameters:

s - The CharSequence to test.

Returns:

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

isIPv6Subnet

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

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

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 CharSequence is a valid IPv6 subnet, 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