com.github.maltalex.ineter.range

Class IPRange<T extends IPAddress & java.lang.Comparable<T>>

java.lang.Object

com.github.maltalex.ineter.range.IPRange<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<T>

Direct Known Subclasses:

IPv4Range, IPv6Range

public abstract class IPRange<T extends IPAddress & java.lang.Comparable<T>>
extends java.lang.Object
implements java.lang.Iterable<T>, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IPRange()

Method Summary

Modifier and Type	Method and Description
boolean	contains(IPRange<T> range) Checks whether this range contains all addresses of a given range.
boolean	contains(T ip) Checks whether a given address is inside this range
boolean	equals(java.lang.Object obj)
abstract T	getFirst()
abstract T	getLast()
int	hashCode()
java.util.Iterator<T>	iterator()
java.util.Iterator<T>	iterator(boolean trim) Returns an iterator that optionally skips both the first and last addresses in the range
abstract java.util.Iterator<T>	iterator(boolean skipFirst, boolean skipLast) Returns an iterator that optionally skips the first, last or both addresses in the range
abstract java.lang.Number	length() Returns the number of addresses in the range
boolean	overlaps(IPRange<T> range) Checks whether this range has any overlapping addresses with a given range.
protected static <T> T	parseRange(java.lang.String from, java.util.function.BiFunction<java.lang.String,java.lang.String,? extends T> rangeProducer, java.util.function.Function<java.lang.String,? extends T> subnetProducer)
protected static <T> T	parseSubnet(java.lang.String from, java.util.function.BiFunction<java.lang.String,java.lang.Integer,? extends T> subnetProducer, int singleAddressMask)
java.lang.String	toString()
abstract java.util.List<? extends IPSubnet<? extends T>>	toSubnets() Calculates and returns the minimal list of Subnets that compose this address range.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

IPRange

public IPRange()

Method Detail

parseRange

protected static <T> T parseRange(java.lang.String from,
                                  java.util.function.BiFunction<java.lang.String,java.lang.String,? extends T> rangeProducer,
                                  java.util.function.Function<java.lang.String,? extends T> subnetProducer)

parseSubnet

protected static <T> T parseSubnet(java.lang.String from,
                                   java.util.function.BiFunction<java.lang.String,java.lang.Integer,? extends T> subnetProducer,
                                   int singleAddressMask)

getFirst

public abstract T getFirst()

getLast

public abstract T getLast()

overlaps

public boolean overlaps(IPRange<T> range)

Checks whether this range 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 one

contains

public boolean contains(T ip)

Checks whether a given address is inside this range

Parameters:

ip -

Returns:

true if the given address is inside this range

contains

public boolean contains(IPRange<T> range)

Checks whether this range 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 range

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

length

public abstract java.lang.Number length()

Returns the number of addresses in the range

Returns:

number of addresses in the range

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T extends IPAddress & java.lang.Comparable<T>>

iterator

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

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

Parameters:

trim - set to true to skip first and last addresses

Returns:

a new iterator instance

iterator

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

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

Parameters:

skipFirst - set to true to skip the first address

skipLast - set to true to skip the last addresses

Returns:

a new iterator instance

toSubnets

public abstract java.util.List<? extends IPSubnet<? extends T>> toSubnets()

Calculates and returns the minimal list of Subnets that compose this address range.

Returns:

a list of Subnets that compose this address range