com.github.robtimus.net.ip

Class Subnet<IP extends IPAddress<IP>>

java.lang.Object

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

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

Type Parameters:

IP - The type of IP address in the subnet.

All Implemented Interfaces:

IPRange<IP>, Iterable<IP>, Collection<IP>

Direct Known Subclasses:

IPv4Subnet, IPv6Subnet

public abstract class Subnet<IP extends IPAddress<IP>>
extends AbstractIPRange<IP>

Represents a subnet of IP addresses. Immutable.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
IP	from() Returns the first IP address in this range.
static boolean	isSubnet(CharSequence s) Tests whether or not a CharSequence is a valid subnet.
static boolean	isSubnet(CharSequence s, int start, int end) Tests whether or not a portion of a CharSequence is a valid subnet.
int	prefixLength() Returns the length of the prefix of this subnet.
IP	routingPrefix() Returns the routing prefix of this subnet.
IP	to() Returns the last IP address in this range.
String	toString()
static Optional<Subnet<?>>	tryValueOf(CharSequence cidrNotation) Attempts to return a subnet represented by a CharSequence.
static Optional<Subnet<?>>	tryValueOf(CharSequence cidrNotation, int start, int end) Attempts to return a subnet represented by a portion of a CharSequence.
static Subnet<?>	valueOf(CharSequence cidrNotation) Returns a subnet represented by a CIDR notation.
static Subnet<?>	valueOf(CharSequence routingPrefix, int prefixLength) Returns a subnet represented by a routing prefix and a prefix length.
static Subnet<?>	valueOf(CharSequence cidrNotation, int start, int end) Returns a subnet represented by a CIDR notation.
static Subnet<?>	valueOf(IPAddress<?> routingPrefix, int prefixLength) Returns a subnet represented by a routing prefix and a prefix length.

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.IPRange

add, addAll, clear, contains, contains, containsAll, forEach, isEmpty, iterator, remove, removeAll, removeIf, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, spliterator, stream

Method Detail

from

public final IP from()

Description copied from interface: IPRange

Returns the first IP address in this range.

Returns:

The first IP address in this range.

to

public final IP to()

Description copied from interface: IPRange

Returns the last IP address in this range. This is possibly the same IP address as IPRange.from() if the IP range contains only one IP address.

Returns:

The last IP address in this range.

routingPrefix

public final IP routingPrefix()

Returns the routing prefix of this subnet.

Returns:

The routing prefix of this subnet.

prefixLength

public final int prefixLength()

Returns the length of the prefix of this subnet.

Returns:

The length of the prefix of this subnet.

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static Subnet<?> valueOf(CharSequence cidrNotation)

Returns a subnet represented by a CIDR notation.

Parameters:

cidrNotation - The CIDR notation representing the subnet.

Returns:

A 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 Subnet<?> valueOf(CharSequence cidrNotation,
                                int start,
                                int end)

Returns a subnet represented by a CIDR notation.

Parameters:

cidrNotation - The CIDR notation representing the 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:

A 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

tryValueOf

public static Optional<Subnet<?>> tryValueOf(CharSequence cidrNotation)

Attempts to return a subnet represented by a CharSequence.

Parameters:

cidrNotation - The possible CIDR notation representing the subnet.

Returns:

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

tryValueOf

public static Optional<Subnet<?>> tryValueOf(CharSequence cidrNotation,
                                             int start,
                                             int end)

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

Parameters:

cidrNotation - The possible CIDR notation representing the 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 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 Subnet<?> valueOf(IPAddress<?> routingPrefix,
                                int prefixLength)

Returns a subnet represented by a routing prefix and a prefix length. The given routing prefix must be the start of the subnet of the given prefix length that contains the routing prefix. For example, 192.168.0.0 is valid for prefix length 16, but 192.168.0.1 is not.

Parameters:

routingPrefix - The routing prefix of the subnet.

prefixLength - The length of the prefix of the subnet.

Returns:

A 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 subnet of the given prefix length that contains the routing prefix.

valueOf

public static Subnet<?> valueOf(CharSequence routingPrefix,
                                int prefixLength)

Returns a subnet represented by a routing prefix and a prefix length. The given routing prefix must be the start of the subnet of the given prefix length that contains the routing prefix. For example, 192.168.0.0 is valid for prefix length 16, but 192.168.0.1 is not.

Parameters:

routingPrefix - The routing prefix of the subnet.

prefixLength - The length of the prefix of the subnet.

Returns:

A 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 subnet of the given prefix length that contains the routing prefix.

See Also:

valueOf(IPAddress, int)

isSubnet

public static boolean isSubnet(CharSequence s)

Tests whether or not a CharSequence is a valid subnet.

Parameters:

s - The CharSequence to test.

Returns:

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

isSubnet

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

Tests whether or not a portion of a CharSequence is a valid 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 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