Module inet.ipaddr

Package inet.ipaddr.ipv4

Class IPv4AddressSeqRange

java.lang.Object

inet.ipaddr.IPAddressSeqRange

inet.ipaddr.ipv4.IPv4AddressSeqRange

All Implemented Interfaces:

AddressComponentRange, AddressItem, AddressItemRange, IPAddressRange, java.io.Serializable, java.lang.Comparable<AddressItem>, java.lang.Iterable<IPv4Address>

public class IPv4AddressSeqRange
extends IPAddressSeqRange
implements java.lang.Iterable<IPv4Address>

Represents an arbitrary range of IPv4 addresses. See IPAddressSeqRange for more details.

Author:

sfoley

See Also:

Serialized Form

Field Summary

Fields inherited from class inet.ipaddr.IPAddressSeqRange

DEFAULT_RANGE_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
IPv4AddressSeqRange(IPv4Address first, IPv4Address second)

Method Summary

Modifier and Type	Method	Description
IPv4Address	coverWithPrefixBlock()	Returns the minimal-size prefix block that covers all the addresses in this range.
long	getIPv4Count()	Equivalent to IPAddressSeqRange.getCount() but returns a long
long	getIPv4PrefixCount(int prefixLength)	Equivalent to getPrefixCount(int) but returns a long
java.lang.Iterable<IPv4Address>	getIterable()	Useful for using an instance in a "for-each loop", as in for(addr : address.getIterable()) { ...
IPv4Address	getLower()	Returns the lowest address in the sequential range, the one with the lowest numeric value
int	getMinPrefixLengthForBlock()	Returns the smallest prefix length possible such that this item includes the block of all values for that prefix length.
java.math.BigInteger	getPrefixCount(int prefixLength)	The count of the number of distinct values within the prefix part of the address item, the bits that appear within the prefix length.
java.lang.Integer	getPrefixLengthForSingleBlock()	Returns a prefix length for which the range of this item matches the block of all values for that prefix length.
IPv4Address	getUpper()	Returns the highest address in the sequential range, the one with the highest numeric value
IPv4AddressSeqRange	intersect(IPAddressSeqRange other)	Returns the intersection of this range with the given range, a range which includes those addresses in both this and the given range.
java.util.Iterator<IPv4Address>	iterator()	Iterates through the individual addresses of this address or subnet.
IPv4AddressSeqRange	join(IPAddressSeqRange other)	Joins two ranges if they are contiguous ranges.
java.util.Iterator<IPv4Address>	prefixBlockIterator(int prefLength)	Iterates through the range of prefix blocks in this range instance using the given prefix length.
AddressComponentRangeSpliterator<IPv4AddressSeqRange,IPv4Address>	prefixBlockSpliterator(int prefLength)	Partitions and traverses through the individual prefix blocks for the given prefix length.
java.util.stream.Stream<IPv4Address>	prefixBlockStream(int prefLength)	Returns a sequential stream of the prefix blocks for the given prefix length.
java.util.Iterator<IPv4AddressSeqRange>	prefixIterator(int prefixLength)	Iterates through the range of prefixes in this range instance using the given prefix length.
AddressComponentSpliterator<IPv4AddressSeqRange>	prefixSpliterator(int prefLength)	Partitions and traverses through the individual prefixes for the given prefix length.
java.util.stream.Stream<IPv4AddressSeqRange>	prefixStream(int prefLength)	Returns a sequential stream of the individual prefixes for the given prefix length.
IPv4Address[]	spanWithPrefixBlocks()	Produces an array of prefix blocks that spans the same set of addresses.
IPv4Address[]	spanWithSequentialBlocks()	Produces an array of blocks that are sequential that cover the same set of addresses.
AddressComponentRangeSpliterator<IPv4AddressSeqRange,IPv4Address>	spliterator()	Partitions and traverses through the individual addresses.
java.util.stream.Stream<IPv4Address>	stream()	Returns a sequential stream of the individual address components.
IPv4AddressSeqRange[]	subtract(IPAddressSeqRange other)	Subtracts the given range from this range, to produce either zero, one, or two address ranges that contain the addresses in this range and not in the given range.
java.lang.String	toIPv4String(java.util.function.Function<IPv4Address,java.lang.String> lowerStringer, java.lang.String separator, java.util.function.Function<IPv4Address,java.lang.String> upperStringer)
IPv4AddressSeqRange	toSequentialRange()	Converts to a sequential range from the lowest and highest addresses in this range, returns "this" if one already

Methods inherited from class inet.ipaddr.IPAddressSeqRange

contains, contains, containsPrefixBlock, containsSinglePrefixBlock, enumerate, equals, extend, getBitCount, getBytes, getBytes, getBytes, getCount, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, hashCode, includesMax, includesZero, isMax, isMore, isMultiple, isSequential, isZero, join, overlaps, overlaps, toCanonicalString, toCanonicalString, toNormalizedString, toNormalizedString, toString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface inet.ipaddr.format.AddressItem

compareTo, getByteCount, isFullRange

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

IPv4AddressSeqRange

public IPv4AddressSeqRange(IPv4Address first,
                           IPv4Address second)

Method Detail

getLower

public IPv4Address getLower()

Description copied from class: IPAddressSeqRange

Returns the lowest address in the sequential range, the one with the lowest numeric value

Specified by:

getLower in interface AddressComponentRange

Specified by:

getLower in interface IPAddressRange

Overrides:

getLower in class IPAddressSeqRange

Returns:

getUpper

public IPv4Address getUpper()

Description copied from class: IPAddressSeqRange

Returns the highest address in the sequential range, the one with the highest numeric value

Specified by:

getUpper in interface AddressComponentRange

Specified by:

getUpper in interface IPAddressRange

Overrides:

getUpper in class IPAddressSeqRange

Returns:

getIPv4Count

public long getIPv4Count()

Equivalent to IPAddressSeqRange.getCount() but returns a long

Returns:

getIPv4PrefixCount

public long getIPv4PrefixCount(int prefixLength)

Equivalent to getPrefixCount(int) but returns a long

Returns:

getPrefixCount

public java.math.BigInteger getPrefixCount(int prefixLength)

Description copied from interface: AddressItem

The count of the number of distinct values within the prefix part of the address item, the bits that appear within the prefix length.

Specified by:

getPrefixCount in interface AddressItem

Returns:

getIterable

public java.lang.Iterable<IPv4Address> getIterable()

Description copied from interface: IPAddressRange

Useful for using an instance in a "for-each loop", as in for(addr : address.getIterable()) { ... }

Otherwise just call IPAddressRange.iterator() directly.

Specified by:

getIterable in interface AddressComponentRange

Specified by:

getIterable in interface IPAddressRange

Specified by:

getIterable in class IPAddressSeqRange

Returns:

iterator

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

Description copied from interface: IPAddressRange

Iterates through the individual addresses of this address or subnet.

Call AddressItem.isMultiple() to determine if this instance represents multiple, or AddressItem.getCount() for the count.

Specified by:

iterator in interface AddressComponentRange

Specified by:

iterator in interface IPAddressRange

Specified by:

iterator in interface java.lang.Iterable<IPv4Address>

Specified by:

iterator in class IPAddressSeqRange

Returns:

spliterator

public AddressComponentRangeSpliterator<IPv4AddressSeqRange,IPv4Address> spliterator()

Description copied from interface: IPAddressRange

Partitions and traverses through the individual addresses.

Specified by:

spliterator in interface AddressComponentRange

Specified by:

spliterator in interface IPAddressRange

Specified by:

spliterator in interface java.lang.Iterable<IPv4Address>

Specified by:

spliterator in class IPAddressSeqRange

Returns:

stream

public java.util.stream.Stream<IPv4Address> stream()

Description copied from interface: AddressComponentRange

Returns a sequential stream of the individual address components. For a parallel stream, call BaseStream.parallel() on the returned stream.

Specified by:

stream in interface AddressComponentRange

Specified by:

stream in class IPAddressSeqRange

Returns:

prefixBlockIterator

public java.util.Iterator<IPv4Address> prefixBlockIterator(int prefLength)

Description copied from class: IPAddressSeqRange

Iterates through the range of prefix blocks in this range instance using the given prefix length.

Specified by:

prefixBlockIterator in interface IPAddressRange

Specified by:

prefixBlockIterator in class IPAddressSeqRange

Returns:

prefixBlockSpliterator

public AddressComponentRangeSpliterator<IPv4AddressSeqRange,IPv4Address> prefixBlockSpliterator(int prefLength)

Description copied from interface: IPAddressRange

Partitions and traverses through the individual prefix blocks for the given prefix length.

Specified by:

prefixBlockSpliterator in interface IPAddressRange

Specified by:

prefixBlockSpliterator in class IPAddressSeqRange

Returns:

prefixBlockStream

public java.util.stream.Stream<IPv4Address> prefixBlockStream(int prefLength)

Description copied from interface: IPAddressRange

Returns a sequential stream of the prefix blocks for the given prefix length. For a parallel stream, call BaseStream.parallel() on the returned stream.

Specified by:

prefixBlockStream in interface IPAddressRange

Specified by:

prefixBlockStream in class IPAddressSeqRange

Returns:

prefixIterator

public java.util.Iterator<IPv4AddressSeqRange> prefixIterator(int prefixLength)

Description copied from class: IPAddressSeqRange

Iterates through the range of prefixes in this range instance using the given prefix length.

Since a range between two arbitrary addresses cannot always be represented with a single IPAddress instance, the returned iterator iterates through IPAddressSeqRange instances.

For instance, if iterating from 1.2.3.4 to 1.2.4.5 with prefix 8, the range shares the same prefix 1, but the range cannot be represented by the address 1.2.3-4.4-5 which does not include 1.2.3.255 or 1.2.4.0 both of which are in the original range. Nor can the range be represented by 1.2.3-4.0-255 which includes 1.2.4.6 and 1.2.3.3, both of which were not in the original range. An IPAddressSeqRange is thus required to represent that prefixed range.

Specified by:

prefixIterator in interface IPAddressRange

Overrides:

prefixIterator in class IPAddressSeqRange

Returns:

prefixStream

public java.util.stream.Stream<IPv4AddressSeqRange> prefixStream(int prefLength)

Description copied from interface: IPAddressRange

Returns a sequential stream of the individual prefixes for the given prefix length. For a parallel stream, call BaseStream.parallel() on the returned stream.

Specified by:

prefixStream in interface IPAddressRange

Specified by:

prefixStream in class IPAddressSeqRange

Returns:

prefixSpliterator

public AddressComponentSpliterator<IPv4AddressSeqRange> prefixSpliterator(int prefLength)

Description copied from interface: IPAddressRange

Partitions and traverses through the individual prefixes for the given prefix length.

Specified by:

prefixSpliterator in interface IPAddressRange

Specified by:

prefixSpliterator in class IPAddressSeqRange

Returns:

coverWithPrefixBlock

public IPv4Address coverWithPrefixBlock()

Description copied from class: IPAddressSeqRange

Returns the minimal-size prefix block that covers all the addresses in this range. The resulting block will have a larger count than this, unless this range already directly corresponds to a prefix block.

Specified by:

coverWithPrefixBlock in interface IPAddressRange

Specified by:

coverWithPrefixBlock in class IPAddressSeqRange

spanWithPrefixBlocks

public IPv4Address[] spanWithPrefixBlocks()

Description copied from interface: IPAddressRange

Produces an array of prefix blocks that spans the same set of addresses.

Specified by:

spanWithPrefixBlocks in interface IPAddressRange

Specified by:

spanWithPrefixBlocks in class IPAddressSeqRange

spanWithSequentialBlocks

public IPv4Address[] spanWithSequentialBlocks()

Description copied from interface: IPAddressRange

Produces an array of blocks that are sequential that cover the same set of addresses. This array can be shorter than that produced by IPAddressRange.spanWithPrefixBlocks() and is never longer.

Specified by:

spanWithSequentialBlocks in interface IPAddressRange

Specified by:

spanWithSequentialBlocks in class IPAddressSeqRange

getMinPrefixLengthForBlock

public int getMinPrefixLengthForBlock()

Description copied from interface: AddressItem

Returns the smallest prefix length possible such that this item includes the block of all values for that prefix length.

If the entire range can be dictated this way, then this method returns the same value as AddressItem.getPrefixLengthForSingleBlock(). Otherwise, this method will return the minimal possible prefix that can be paired with this address, while AddressItem.getPrefixLengthForSingleBlock() will return null.

In cases where the final bit is constant so there is no such block, this returns the bit count.

Specified by:

getMinPrefixLengthForBlock in interface AddressItem

Returns:

the prefix length

getPrefixLengthForSingleBlock

public java.lang.Integer getPrefixLengthForSingleBlock()

Description copied from interface: AddressItem

Returns a prefix length for which the range of this item matches the block of all values for that prefix length.

If the range can be dictated this way, then this method returns the same value as AddressItem.getMinPrefixLengthForBlock().

If no such prefix length exists, returns null.

If this item represents a single value, this returns the bit count.

Specified by:

getPrefixLengthForSingleBlock in interface AddressItem

Returns:

the prefix length or null

toIPv4String

public java.lang.String toIPv4String(java.util.function.Function<IPv4Address,java.lang.String> lowerStringer,
                                     java.lang.String separator,
                                     java.util.function.Function<IPv4Address,java.lang.String> upperStringer)

intersect

public IPv4AddressSeqRange intersect(IPAddressSeqRange other)

Description copied from class: IPAddressSeqRange

Returns the intersection of this range with the given range, a range which includes those addresses in both this and the given range.

Overrides:

intersect in class IPAddressSeqRange

Returns:

join

public IPv4AddressSeqRange join(IPAddressSeqRange other)

Description copied from class: IPAddressSeqRange

Joins two ranges if they are contiguous ranges. If this range overlaps the given range, or if the highest value of the lower range is one below the lowest value of the higher range, then the two are joined into a new larger range that is returned.

Otherwise, null is returned.

Overrides:

join in class IPAddressSeqRange

Returns:

subtract

public IPv4AddressSeqRange[] subtract(IPAddressSeqRange other)

Description copied from class: IPAddressSeqRange

Subtracts the given range from this range, to produce either zero, one, or two address ranges that contain the addresses in this range and not in the given range. If the result has length 2, the two ranges are ordered by ascending lowest range value.

Overrides:

subtract in class IPAddressSeqRange

Returns:

toSequentialRange

public IPv4AddressSeqRange toSequentialRange()

Description copied from interface: IPAddressRange

Converts to a sequential range from the lowest and highest addresses in this range, returns "this" if one already

The result will represent the same set of addresses if and only if IPAddressRange.isSequential() is true

Specified by:

toSequentialRange in interface IPAddressRange