inet.ipaddr.format

Interface IPAddressRange

All Superinterfaces:

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

All Known Implementing Classes:

IPAddress, IPAddressSeqRange, IPv4Address, IPv4AddressSeqRange, IPv6Address, IPv6AddressSeqRange

public interface IPAddressRange
extends AddressItemRange

Method Summary

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
java.lang.Iterable<? extends IPAddress>	getIterable() Useful for using an instance in a "for-each loop", as in for(addr : address.getIterable()) { ...
IPAddress	getLower() If this instance represents multiple individual addresses, returns the one with the lowest numeric value.
IPAddress	getUpper() If this instance represents multiple individual addresses, returns the one with the highest numeric value.
java.util.Iterator<? extends IPAddress>	iterator() Iterates through the individual addresses of this address or subnet.
java.util.Iterator<? extends IPAddress>	prefixBlockIterator(int prefLength) Iterates through the range of prefix blocks in this range instance using the given prefix length.
java.util.Iterator<? extends IPAddressRange>	prefixIterator(int prefixLength) Iterates through the range of prefixes in this range instance using the given prefix length.
IPAddress[]	spanWithPrefixBlocks() Produces an array of prefix blocks that cover the same set of addresses.
IPAddress[]	spanWithSequentialBlocks() Produces an array of blocks that are sequential that cover the same set of addresses.
java.lang.String	toCanonicalString() Produces a string that is unique and uses the canonical representation for all instances.
java.lang.String	toNormalizedString() Produces a string that is unique and consistent for all instances.

Methods inherited from interface inet.ipaddr.format.AddressItem

compareTo, containsPrefixBlock, containsSinglePrefixBlock, getBitCount, getByteCount, getBytes, getBytes, getBytes, getCount, getMinPrefixLengthForBlock, getPrefixCount, getPrefixLengthForSingleBlock, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isZero, testRange, testRange

Method Detail

contains

boolean contains(IPAddressSeqRange other)

Returns whether this range contains all addresses in the given sequential range

Parameters:

other -

Returns:

contains

boolean contains(IPAddress other)

Returns whether this range contains all addresses in the given address or subnet

Parameters:

other -

Returns:

getLower

IPAddress getLower()

If this instance represents multiple individual addresses, returns the one with the lowest numeric value.

Specified by:

getLower in interface AddressItemRange

Returns:

getUpper

IPAddress getUpper()

If this instance represents multiple individual addresses, returns the one with the highest numeric value.

Specified by:

getUpper in interface AddressItemRange

Returns:

getIterable

java.lang.Iterable<? extends IPAddress> getIterable()

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

Otherwise just call iterator() directly.

Specified by:

getIterable in interface AddressItemRange

Returns:

iterator

java.util.Iterator<? extends IPAddress> iterator()

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 AddressItemRange

Returns:

prefixBlockIterator

java.util.Iterator<? extends IPAddress> prefixBlockIterator(int prefLength)

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

Parameters:

prefLength -

Returns:

prefixIterator

java.util.Iterator<? extends IPAddressRange> prefixIterator(int prefixLength)

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

Parameters:

prefixLength -

Returns:

spanWithPrefixBlocks

IPAddress[] spanWithPrefixBlocks()

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

spanWithSequentialBlocks

IPAddress[] spanWithSequentialBlocks()

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

toNormalizedString

java.lang.String toNormalizedString()

Produces a string that is unique and consistent for all instances.

Returns:

toCanonicalString

java.lang.String toCanonicalString()

Produces a string that is unique and uses the canonical representation for all instances.

Returns: