public abstract class IPAddressSeqRange extends Object implements IPAddressRange
Note that the IPAddress and IPAddressString classes allow you to specify a range of values for each segment.
That allows you to represent single addresses, any address prefix subnet (eg 1.2.0.0/16 or 1:2:3:4::/64) or any subnet that can be represented with segment ranges (1.2.0-255.* or 1:2:3:4:*), see
IPAddressString
for details.
IPAddressString and IPAddress cover all potential subnets and addresses that can be represented by a single address string of 4 or less segments for IPv4, and 8 or less segments for IPv6.
This class allows the representation of any sequential address range, including those that cannot be represented by IPAddress.
String representations include the full address for both the lower and upper bounds of the range.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_RANGE_SEPARATOR |
Modifier and Type | Method and Description |
---|---|
boolean |
contains(IPAddress other)
Returns whether this range contains all addresses in the given address or subnet
|
boolean |
contains(IPAddressSeqRange other)
Returns whether this range contains all addresses in the given sequential range
|
boolean |
containsPrefixBlock(int prefixLen)
Returns whether the values of this series contains the prefix block for the given prefix length.
|
boolean |
containsSinglePrefixBlock(int prefixLen)
Returns whether the values of this series contains a single prefix block for the given prefix length.
|
abstract IPAddress |
coverWithPrefixBlock()
Returns the minimal-size prefix block that covers all the addresses in this range.
|
BigInteger |
enumerate(IPAddress other)
Returns the distance of the given address from the initial value of this range.
|
boolean |
equals(Object o)
Returns whether the given sequential address range is equal to this sequential address range.
|
IPAddressSeqRange |
extend(IPAddressRange other)
Extend this sequential range to include all address in the given range, which can be an IPAddress or IPAddressSeqRange.
|
int |
getBitCount()
Provides the number of bits comprising this address item
|
byte[] |
getBytes() |
byte[] |
getBytes(byte[] bytes)
Copies the bytes of the lowest address item represented by this address item into the supplied array,
and returns that array.
|
byte[] |
getBytes(byte[] bytes,
int index)
Copies the bytes of the lowest address item represented by this address item into the supplied array starting at the given index,
and returns that array.
|
BigInteger |
getCount()
The count of possible distinct values for this AddressComponent.
|
abstract Iterable<? extends IPAddress> |
getIterable()
Useful for using an instance in a "for-each loop", as in
for(addr : address.getIterable()) { ... |
IPAddress |
getLower()
Returns the lowest address in the sequential range, the one with the lowest numeric value
|
IPAddress |
getUpper()
Returns the highest address in the sequential range, the one with the highest numeric value
|
byte[] |
getUpperBytes() |
byte[] |
getUpperBytes(byte[] bytes)
Copies the bytes of the largest address item represented by this address item into the supplied array,
and returns that array.
|
byte[] |
getUpperBytes(byte[] bytes,
int index)
Copies the bytes of the largest address item represented by this address item into the supplied array at the given index,
and returns that array.
|
BigInteger |
getUpperValue()
Returns the highest value represented by this address item, the highest value included in the range of values
|
BigInteger |
getValue()
Returns the lowest value represented by this address item, the lowest value included in the range of values
|
int |
hashCode() |
boolean |
includesMax()
Returns whether this sequential range's upper value is the highest address, the address whose bits are all ones.
|
boolean |
includesZero()
Returns whether this sequential range's lower value is the zero address.
|
IPAddressSeqRange |
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.
|
boolean |
isMax()
Returns whether this sequential range spans from the highest address, the address whose bits are all ones, to itself.
|
boolean |
isMore(IPAddressSeqRange other) |
boolean |
isMultiple()
Whether this represents multiple potential values (eg a prefixed address or a segment representing a range of values)
|
boolean |
isSequential()
Returns whether the address or subnet represents a range of values that are sequential.
|
boolean |
isZero()
Returns whether this sequential range spans from the zero address to itself.
|
abstract Iterator<? extends IPAddress> |
iterator()
Iterates through the individual addresses of this address or subnet.
|
static IPAddressSeqRange[] |
join(IPAddressSeqRange... ranges)
Joins the given ranges into the fewest number of ranges.
|
IPAddressSeqRange |
join(IPAddressSeqRange other)
Joins two ranges if they are contiguous ranges.
|
boolean |
overlaps(IPAddress other)
Returns true if this sequential range overlaps the given address or subnet.
|
boolean |
overlaps(IPAddressSeqRange other)
Returns true if this sequential range overlaps the given sequential range.
|
abstract Iterator<? extends IPAddress> |
prefixBlockIterator(int prefLength)
Iterates through the range of prefix blocks in this range instance using the given prefix length.
|
abstract AddressComponentRangeSpliterator<? extends IPAddressSeqRange,? extends IPAddress> |
prefixBlockSpliterator(int prefLength)
Partitions and traverses through the individual prefix blocks for the given prefix length.
|
abstract Stream<? extends IPAddress> |
prefixBlockStream(int prefLength)
Returns a sequential stream of the prefix blocks for the given prefix length.
|
Iterator<? extends IPAddressSeqRange> |
prefixIterator(int prefixLength)
Iterates through the range of prefixes in this range instance using the given prefix length.
|
abstract AddressComponentSpliterator<? extends IPAddressSeqRange> |
prefixSpliterator(int prefLength)
Partitions and traverses through the individual prefixes for the given prefix length.
|
abstract Stream<? extends IPAddressSeqRange> |
prefixStream(int prefLength)
Returns a sequential stream of the individual prefixes for the given prefix length.
|
abstract IPAddress[] |
spanWithPrefixBlocks()
Produces an array of prefix blocks that spans the same set of addresses.
|
abstract IPAddress[] |
spanWithSequentialBlocks()
Produces an array of blocks that are sequential that cover the same set of addresses.
|
abstract AddressComponentRangeSpliterator<? extends IPAddressSeqRange,? extends IPAddress> |
spliterator()
Partitions and traverses through the individual addresses.
|
abstract Stream<? extends IPAddress> |
stream()
Returns a sequential stream of the individual address components.
|
IPAddressSeqRange[] |
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.
|
String |
toCanonicalString()
Produces a canonical string for the address range.
|
String |
toCanonicalString(String separator)
Produces a canonical string for the address range with the given separator string.
|
String |
toNormalizedString()
Produces a normalized string for the address range.
|
String |
toNormalizedString(String separator) |
String |
toString()
Produces the canonical string for the address, also available from
toCanonicalString() . |
String |
toString(Function<? super IPAddress,String> lowerStringer,
String separator,
Function<? super IPAddress,String> upperStringer) |
toSequentialRange
stream, stream
compareTo, getBitsForCount, getBlockSize, getByteCount, getMinPrefixLengthForBlock, getPrefixCount, getPrefixLengthForSingleBlock, isFullRange
public static final String DEFAULT_RANGE_SEPARATOR
public BigInteger getCount()
AddressItem
getCount
in interface AddressItem
public boolean isMultiple()
AddressItem
isMultiple
in interface AddressItem
public boolean isMore(IPAddressSeqRange other)
other
- the range to compare, which does not need to range across the same address spacepublic abstract Iterable<? extends IPAddress> getIterable()
IPAddressRange
for(addr : address.getIterable()) { ... }
Otherwise just call IPAddressRange.iterator()
directly.
getIterable
in interface AddressComponentRange
getIterable
in interface IPAddressRange
public abstract Iterator<? extends IPAddress> prefixBlockIterator(int prefLength)
prefixBlockIterator
in interface IPAddressRange
prefLength
- public abstract AddressComponentRangeSpliterator<? extends IPAddressSeqRange,? extends IPAddress> prefixBlockSpliterator(int prefLength)
IPAddressRange
prefixBlockSpliterator
in interface IPAddressRange
public abstract Stream<? extends IPAddress> prefixBlockStream(int prefLength)
IPAddressRange
BaseStream.parallel()
on the returned stream.prefixBlockStream
in interface IPAddressRange
public Iterator<? extends IPAddressSeqRange> prefixIterator(int prefixLength)
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.
prefixIterator
in interface IPAddressRange
prefixLength
- public abstract AddressComponentSpliterator<? extends IPAddressSeqRange> prefixSpliterator(int prefLength)
IPAddressRange
prefixSpliterator
in interface IPAddressRange
public abstract Stream<? extends IPAddressSeqRange> prefixStream(int prefLength)
IPAddressRange
BaseStream.parallel()
on the returned stream.prefixStream
in interface IPAddressRange
public abstract Iterator<? extends IPAddress> iterator()
IPAddressRange
Call AddressItem.isMultiple()
to determine if this instance represents multiple, or AddressItem.getCount()
for the count.
iterator
in interface AddressComponentRange
iterator
in interface IPAddressRange
public abstract AddressComponentRangeSpliterator<? extends IPAddressSeqRange,? extends IPAddress> spliterator()
IPAddressRange
spliterator
in interface AddressComponentRange
spliterator
in interface IPAddressRange
public abstract Stream<? extends IPAddress> stream()
AddressComponentRange
BaseStream.parallel()
on the returned stream.stream
in interface AddressComponentRange
public IPAddress getLower()
getLower
in interface AddressComponentRange
getLower
in interface IPAddressRange
public IPAddress getUpper()
getUpper
in interface AddressComponentRange
getUpper
in interface IPAddressRange
public String toNormalizedString()
getLower()
and getUpper()
.toNormalizedString
in interface IPAddressRange
public String toCanonicalString(String separator)
public String toCanonicalString()
getLower()
and getUpper()
.toCanonicalString
in interface IPAddressRange
public String toString(Function<? super IPAddress,String> lowerStringer, String separator, Function<? super IPAddress,String> upperStringer)
public String toString()
toCanonicalString()
.public abstract IPAddress coverWithPrefixBlock()
coverWithPrefixBlock
in interface IPAddressRange
public abstract IPAddress[] spanWithPrefixBlocks()
IPAddressRange
spanWithPrefixBlocks
in interface IPAddressRange
public abstract IPAddress[] spanWithSequentialBlocks()
IPAddressRange
IPAddressRange.spanWithPrefixBlocks()
and is never longer.spanWithSequentialBlocks
in interface IPAddressRange
public static IPAddressSeqRange[] join(IPAddressSeqRange... ranges)
ranges
- public boolean overlaps(IPAddress other)
overlaps
in interface IPAddressRange
other
- public boolean overlaps(IPAddressSeqRange other)
overlaps
in interface IPAddressRange
other
- public boolean contains(IPAddress other)
IPAddressRange
contains
in interface IPAddressRange
public boolean contains(IPAddressSeqRange other)
IPAddressRange
contains
in interface IPAddressRange
public BigInteger enumerate(IPAddress other)
If within or above the range, it is the distance to the lower boundary of the sequential range. If below the, returns the number of addresses following the address to the lower range boundary.
The method does not return null if this range does not contain the address. You can call contains(IPAddress)
or you can compare with getCount()
to check for containment.
An address is in the range if 0 <= enumerate(IPAddress)
< getCount()
.
Returns null when the argument is a multi-valued subnet. The argument must be an individual address.
If the given address does not have the same version or type as the addresses in this range, then null is returned.
enumerate
in interface IPAddressRange
public boolean isSequential()
IP address sequential ranges are sequential by definition, so this returns true.
isSequential
in interface IPAddressRange
public boolean equals(Object o)
public IPAddressSeqRange intersect(IPAddressSeqRange other)
other
- public IPAddressSeqRange join(IPAddressSeqRange other)
Otherwise, null is returned.
other
- public IPAddressSeqRange extend(IPAddressRange other)
other
- public IPAddressSeqRange[] subtract(IPAddressSeqRange other)
other
- public boolean containsPrefixBlock(int prefixLen)
AddressItem
Use AddressItem.getMinPrefixLengthForBlock()
to determine the smallest prefix length for which this method returns true.
containsPrefixBlock
in interface AddressItem
public boolean containsSinglePrefixBlock(int prefixLen)
AddressItem
Use AddressItem.getPrefixLengthForSingleBlock()
to determine whether there is a prefix length for which this method returns true.
containsSinglePrefixBlock
in interface AddressItem
public int getBitCount()
AddressItem
getBitCount
in interface AddressItem
public byte[] getBytes()
getBytes
in interface AddressItem
public byte[] getBytes(byte[] bytes)
AddressItem
getBytes
in interface AddressItem
public byte[] getBytes(byte[] bytes, int index)
AddressItem
getBytes
in interface AddressItem
public byte[] getUpperBytes()
getUpperBytes
in interface AddressItem
public byte[] getUpperBytes(byte[] bytes)
AddressItem
getUpperBytes
in interface AddressItem
public byte[] getUpperBytes(byte[] bytes, int index)
AddressItem
getUpperBytes
in interface AddressItem
public BigInteger getValue()
AddressItem
getValue
in interface AddressItem
public BigInteger getUpperValue()
AddressItem
getUpperValue
in interface AddressItem
public boolean isZero()
isZero
in interface AddressItem
public boolean includesZero()
includesZero
in interface AddressItem
public boolean isMax()
isMax
in interface AddressItem
public boolean includesMax()
includesMax
in interface AddressItem