IPAddressSeqRange (IPAddress javadoc by seancfoley)

java.lang.Object
- inet.ipaddr.IPAddressSeqRange

All Implemented Interfaces:

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

Direct Known Subclasses:

IPv4AddressSeqRange, IPv6AddressSeqRange
```
public abstract class IPAddressSeqRange
extends java.lang.Object
implements IPAddressRange
```
This class can be used to represent an arbitrary range of IP addresses.
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.

See Also:

Serialized Form

Core

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
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.
`boolean`	`equals(java.lang.Object o)`
`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.
`java.math.BigInteger`	`getCount()` The count of possible distinct values for this AddressComponent.
`abstract java.lang.Iterable<? extends IPAddress>`	`getIterable()` Useful for using an instance in a "for-each loop", as in `for(addr : address.getIterable()) { ...`
`IPAddress`	`getLower()` Returns the address in the range with the lowest numeric value.
`IPAddress`	`getUpper()` Returns the address in the range 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.
`java.math.BigInteger`	`getUpperValue()` Returns the highest value represented by this address item, the highest value included in the range of values
`java.math.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 item includes the maximum possible value for the address type or version within its range
`boolean`	`includesZero()` Returns whether this item includes the value of zero within its range
`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 rqnge.
`boolean`	`isMax()` Returns whether this item matches the maximum possible value for the address type or version
`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`	`isZero()` Returns whether this item matches the value of zero
`abstract java.util.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)` If this range overlaps with 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.
`boolean`	`overlaps(IPAddressSeqRange other)`
`abstract java.util.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 java.util.stream.Stream<? extends IPAddress>`	`prefixBlockStream(int prefLength)` Returns a sequential stream of the prefix blocks for the given prefix length.
`java.util.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 java.util.stream.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 java.util.stream.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.
`java.lang.String`	`toCanonicalString()` Produces a string that is unique and uses the canonical representation for all instances.
`java.lang.String`	`toCanonicalString(java.lang.String separator)`
`java.lang.String`	`toNormalizedString()` Produces a string that is unique and consistent for all instances.
`java.lang.String`	`toNormalizedString(java.lang.String separator)`
`java.lang.String`	`toString()`
`java.lang.String`	`toString(java.util.function.Function<? super IPAddress,java.lang.String> lowerStringer, java.lang.String separator, java.util.function.Function<? super IPAddress,java.lang.String> upperStringer)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface inet.ipaddr.format.AddressComponentRange
stream, stream

Methods inherited from interface inet.ipaddr.format.AddressItem
compareTo, getByteCount, getMinPrefixLengthForBlock, getPrefixCount, getPrefixLengthForSingleBlock, isFullRange, testRange, testRange

- Method Detail
  - getCount
```
public java.math.BigInteger getCount()
```
    Description copied from interface: AddressItem
    
    The count of possible distinct values for this AddressComponent. If not multiple, this is 1. For instance, if this is the ip address series subnet 0::/64, then the count is 2 to the power of 64. If this is a the segment 3-7, then the count is 5.
    
    Specified by:
    
    getCount in interface AddressItem
    
    Returns:
  - isMultiple
```
public boolean isMultiple()
```
    Description copied from interface: AddressItem
    
    Whether this represents multiple potential values (eg a prefixed address or a segment representing a range of values)
    
    Specified by:
    
    isMultiple in interface AddressItem
  - isMore
```
public boolean isMore(IPAddressSeqRange other)
```
    Parameters:
    
    other - the range to compare, which does not need to range across the same address space
    
    Returns:
    
    whether this range spans more addresses than the provided range.
  - getIterable
```
public abstract java.lang.Iterable<? extends IPAddress> 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
    
    Returns:
  - prefixBlockIterator
```
public abstract java.util.Iterator<? extends IPAddress> prefixBlockIterator(int prefLength)
```
    Iterates through the range of prefix blocks in this range instance using the given prefix length.
    
    Specified by:
    
    prefixBlockIterator in interface IPAddressRange
    
    Parameters:
    
    prefLength -
    
    Returns:
  - prefixBlockSpliterator
```
public abstract AddressComponentRangeSpliterator<? extends IPAddressSeqRange,? extends IPAddress> 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
    
    Returns:
  - prefixBlockStream
```
public abstract java.util.stream.Stream<? extends IPAddress> 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
    
    Returns:
  - prefixIterator
```
public java.util.Iterator<? extends IPAddressSeqRange> prefixIterator(int prefixLength)
```
    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 IPAddressRange 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
    
    Parameters:
    
    prefixLength -
    
    Returns:
  - prefixSpliterator
```
public abstract AddressComponentSpliterator<? extends IPAddressSeqRange> 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
    
    Returns:
  - prefixStream
```
public abstract java.util.stream.Stream<? extends IPAddressSeqRange> 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
    
    Returns:
  - iterator
```
public abstract java.util.Iterator<? extends IPAddress> 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
    
    Returns:
  - spliterator
```
public abstract AddressComponentRangeSpliterator<? extends IPAddressSeqRange,? extends IPAddress> 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
    
    Returns:
  - stream
```
public abstract java.util.stream.Stream<? extends IPAddress> 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
    
    Returns:
  - getLower
```
public IPAddress getLower()
```
    Description copied from interface: IPAddressRange
    
    Returns the address in the range with the lowest numeric value.
    
    Specified by:
    
    getLower in interface AddressComponentRange
    
    Specified by:
    
    getLower in interface IPAddressRange
    
    Returns:
  - getUpper
```
public IPAddress getUpper()
```
    Description copied from interface: IPAddressRange
    
    Returns the address in the range with the highest numeric value.
    
    Specified by:
    
    getUpper in interface AddressComponentRange
    
    Specified by:
    
    getUpper in interface IPAddressRange
    
    Returns:
  - toNormalizedString
```
public java.lang.String toNormalizedString(java.lang.String separator)
```
  - toNormalizedString
```
public java.lang.String toNormalizedString()
```
    Description copied from interface: IPAddressRange
    
    Produces a string that is unique and consistent for all instances.
    
    Specified by:
    
    toNormalizedString in interface IPAddressRange
    
    Returns:
  - toCanonicalString
```
public java.lang.String toCanonicalString(java.lang.String separator)
```
  - toCanonicalString
```
public java.lang.String toCanonicalString()
```
    Description copied from interface: IPAddressRange
    
    Produces a string that is unique and uses the canonical representation for all instances.
    
    Specified by:
    
    toCanonicalString in interface IPAddressRange
    
    Returns:
  - toString
```
public java.lang.String toString(java.util.function.Function<? super IPAddress,java.lang.String> lowerStringer,
                                 java.lang.String separator,
                                 java.util.function.Function<? super IPAddress,java.lang.String> upperStringer)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - coverWithPrefixBlock
```
public abstract IPAddress coverWithPrefixBlock()
```
    Description copied from interface: IPAddressRange
    
    Returns the minimal-size prefix block that covers all the addresses in this range. The resulting block will have a larger address count than this range, unless this range is already a prefix block.
    
    Specified by:
    
    coverWithPrefixBlock in interface IPAddressRange
  - spanWithPrefixBlocks
```
public abstract IPAddress[] 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
  - spanWithSequentialBlocks
```
public abstract IPAddress[] 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
  - join
```
public static IPAddressSeqRange[] join(IPAddressSeqRange... ranges)
```
    Joins the given ranges into the fewest number of ranges. The returned array will be sorted by ascending lowest range value.
    
    Parameters:
    
    ranges -
    
    Returns:
  - overlaps
```
public boolean overlaps(IPAddressSeqRange other)
```
  - contains
```
public boolean contains(IPAddress other)
```
    Description copied from interface: IPAddressRange
    
    Returns whether this range contains all addresses in the given address or subnet
    
    Specified by:
    
    contains in interface IPAddressRange
    
    Returns:
  - contains
```
public boolean contains(IPAddressSeqRange other)
```
    Description copied from interface: IPAddressRange
    
    Returns whether this range contains all addresses in the given sequential range
    
    Specified by:
    
    contains in interface IPAddressRange
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - intersect
```
public 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 rqnge.
    
    Parameters:
    
    other -
    
    Returns:
  - join
```
public IPAddressSeqRange join(IPAddressSeqRange other)
```
    If this range overlaps with 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.
    
    Parameters:
    
    other -
    
    Returns:
  - subtract
```
public 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. If the result has length 2, the two ranges are ordered by ascending lowest range value.
    
    Parameters:
    
    other -
    
    Returns:
  - containsPrefixBlock
```
public boolean containsPrefixBlock(int prefixLen)
```
    Description copied from interface: AddressItem
    
    Returns whether the values of this series contains the prefix block for the given prefix length.
    Use AddressItem.getMinPrefixLengthForBlock() to determine the smallest prefix length for which this method returns true.
    
    Specified by:
    
    containsPrefixBlock in interface AddressItem
    
    Returns:
  - containsSinglePrefixBlock
```
public boolean containsSinglePrefixBlock(int prefixLen)
```
    Description copied from interface: AddressItem
    
    Returns whether the values of this series contains a single prefix block for the given prefix length.
    Use AddressItem.getPrefixLengthForSingleBlock() to determine whether there is a prefix length for which this method returns true.
    
    Specified by:
    
    containsSinglePrefixBlock in interface AddressItem
    
    Returns:
  - getBitCount
```
public int getBitCount()
```
    Description copied from interface: AddressItem
    
    Provides the number of bits comprising this address item
    
    Specified by:
    
    getBitCount in interface AddressItem
    
    Returns:
    
    the number of bits
  - getBytes
```
public byte[] getBytes()
```
    Specified by:
    
    getBytes in interface AddressItem
    
    Returns:
    
    the bytes of the lowest address item represented by this address item
  - getBytes
```
public byte[] getBytes(byte[] bytes)
```
    Description copied from interface: AddressItem
    
    Copies the bytes of the lowest address item represented by this address item into the supplied array, and returns that array. If the supplied array is null or of insufficient size, a new array is created and returned.
    
    Specified by:
    
    getBytes in interface AddressItem
    
    Returns:
    
    the bytes of the lowest address represented by this address item.
  - getBytes
```
public byte[] getBytes(byte[] bytes,
                       int index)
```
    Description copied from interface: AddressItem
    
    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. If the supplied array is null or of insufficient size, a new array is created and returned, with the rest of the array contents the same as the original.
    
    Specified by:
    
    getBytes in interface AddressItem
    
    Returns:
    
    the bytes of the lowest address represented by this address item.
  - getUpperBytes
```
public byte[] getUpperBytes()
```
    Specified by:
    
    getUpperBytes in interface AddressItem
    
    Returns:
    
    the bytes of the largest address item represented by this address item
  - getUpperBytes
```
public byte[] getUpperBytes(byte[] bytes)
```
    Description copied from interface: AddressItem
    
    Copies the bytes of the largest address item represented by this address item into the supplied array, and returns that array. If the supplied array is null or of insufficient size, a new array is created and returned, with the rest of the array contents the same as the original.
    
    Specified by:
    
    getUpperBytes in interface AddressItem
    
    Returns:
    
    the bytes of the largest address represented by this address item.
  - getUpperBytes
```
public byte[] getUpperBytes(byte[] bytes,
                            int index)
```
    Description copied from interface: AddressItem
    
    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. If the supplied array is null or of insufficient size, a new array is created and returned.
    
    Specified by:
    
    getUpperBytes in interface AddressItem
    
    Returns:
    
    the bytes of the largest address represented by this address item.
  - getValue
```
public java.math.BigInteger getValue()
```
    Description copied from interface: AddressItem
    
    Returns the lowest value represented by this address item, the lowest value included in the range of values
    
    Specified by:
    
    getValue in interface AddressItem
    
    Returns:
    
    the lowest value represented by this address item
  - getUpperValue
```
public java.math.BigInteger getUpperValue()
```
    Description copied from interface: AddressItem
    
    Returns the highest value represented by this address item, the highest value included in the range of values
    
    Specified by:
    
    getUpperValue in interface AddressItem
    
    Returns:
    
    the highest value represented by this address item
  - isZero
```
public boolean isZero()
```
    Description copied from interface: AddressItem
    
    Returns whether this item matches the value of zero
    
    Specified by:
    
    isZero in interface AddressItem
    
    Returns:
    
    whether this item matches the value of zero
  - includesZero
```
public boolean includesZero()
```
    Description copied from interface: AddressItem
    
    Returns whether this item includes the value of zero within its range
    
    Specified by:
    
    includesZero in interface AddressItem
    
    Returns:
    
    whether this item includes the value of zero within its range
  - isMax
```
public boolean isMax()
```
    Description copied from interface: AddressItem
    
    Returns whether this item matches the maximum possible value for the address type or version
    
    Specified by:
    
    isMax in interface AddressItem
    
    Returns:
    
    whether this item matches the maximum possible value
  - includesMax
```
public boolean includesMax()
```
    Description copied from interface: AddressItem
    
    Returns whether this item includes the maximum possible value for the address type or version within its range
    
    Specified by:
    
    includesMax in interface AddressItem
    
    Returns:
    
    whether this item includes the maximum possible value within its range

Class IPAddressSeqRange

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface inet.ipaddr.format.AddressComponentRange

Methods inherited from interface inet.ipaddr.format.AddressItem

Method Detail

getCount

isMultiple

isMore

getIterable

prefixBlockIterator

prefixBlockSpliterator

prefixBlockStream

prefixIterator

prefixSpliterator

prefixStream

iterator

spliterator

stream

getLower

getUpper

toNormalizedString

toNormalizedString

toCanonicalString

toCanonicalString

toString

toString

coverWithPrefixBlock

spanWithPrefixBlocks

spanWithSequentialBlocks

join

overlaps

contains

contains

hashCode

equals

intersect

join

subtract

containsPrefixBlock

containsSinglePrefixBlock

getBitCount

getBytes

getBytes

getBytes

getUpperBytes

getUpperBytes

getUpperBytes

getValue

getUpperValue

isZero

includesZero

isMax

includesMax