com.github.maltalex.ineter.range

Interface IPSubnet<T extends IPAddress & java.lang.Comparable<T>>

All Superinterfaces:

java.lang.Iterable<T>

All Known Implementing Classes:

IPv4Subnet, IPv6Subnet

public interface IPSubnet<T extends IPAddress & java.lang.Comparable<T>>
extends java.lang.Iterable<T>

Method Summary

Modifier and Type	Method and Description
boolean	contains(IPRange<T> range) Checks whether this subnet contains all addresses of a given range.
boolean	contains(T ip) Checks whether a given address is inside this subnet
T	getFirst() Returns the network address, same as getNetworkAddress()
int	getHostBitCount() Returns the number of bits used for the host part of the address.
T	getLast() Returns the last address in the subnet
T	getNetworkAddress() Returns the address of the network (with all host bits set to zero) same as getFirst()
int	getNetworkBitCount() Returns the number of bits used for the network address.
T	getNetworkMask() Returns the network mask in address form
java.util.Iterator<T>	iterator(boolean trim) Returns an iterator that optionally skips both the first and last addresses in the subnet
java.util.Iterator<T>	iterator(boolean skipFirst, boolean skipLast) Returns an iterator that optionally skips the first, last or both addresses in the subnet
java.lang.Number	length() Returns the number of addresses in the subnet
boolean	overlaps(IPRange<T> range) Checks whether this subnet has any overlapping addresses with a given range.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getNetworkMask

T getNetworkMask()

Returns the network mask in address form

Returns:

network mask of this subnet

getNetworkBitCount

int getNetworkBitCount()

Returns the number of bits used for the network address. This number is equal to the number of bits in the address (32 or 128) minus the number of bits used for the host. This is the same as the number that comes after the "/" in CIDR notation

Returns:

number of bits in network

getHostBitCount

int getHostBitCount()

Returns the number of bits used for the host part of the address. This number is equal to the number of bits in the address (32 or 128) minus the number of bits used for the network

Returns:

number of bits in the host part of the subnet

getNetworkAddress

T getNetworkAddress()

Returns the address of the network (with all host bits set to zero) same as getFirst()

Returns:

overlaps

boolean overlaps(IPRange<T> range)

Checks whether this subnet has any overlapping addresses with a given range. To check whether all addresses are contained, use contains(IPRange)

Parameters:

range - the range to check for overlap

Returns:

true if the given range overlaps with this subnet

contains

boolean contains(T ip)

Checks whether a given address is inside this subnet

Parameters:

ip -

Returns:

true if the given address is inside this subnet

contains

boolean contains(IPRange<T> range)

Checks whether this subnet contains all addresses of a given range. To check for partial overlap, use overlaps(IPRange)

Parameters:

range - range to check

Returns:

true if the entire given range is contained within this subnet

getFirst

T getFirst()

Returns the network address, same as getNetworkAddress()

Returns:

the network address

getLast

T getLast()

Returns the last address in the subnet

Returns:

the last address in the subnet

iterator

java.util.Iterator<T> iterator(boolean trim)

Returns an iterator that optionally skips both the first and last addresses in the subnet

Parameters:

trim - set to true to skip first and last addresses

Returns:

a new iterator instance

iterator

java.util.Iterator<T> iterator(boolean skipFirst,
                               boolean skipLast)

Returns an iterator that optionally skips the first, last or both addresses in the subnet

Parameters:

skipFirst - set to true to skip the first address

skipLast - set to true to skip the last addresses

Returns:

a new iterator instance

length

java.lang.Number length()

Returns the number of addresses in the subnet

Returns:

number of addresses in the subnet