public abstract class IPAddress extends Address implements IPAddressSegmentSeries, IPAddressRange
IPAddress objects are immutable and cannot change values. This also makes them thread-safe.
String creation:
There are various methods used to construct standard address string such as Address.toCanonicalString()
or Address.toNormalizedString()
There are also several public classes used to create customized IP address strings.
For single strings from an address or address section, you use IPAddressSection.IPStringOptions
or IPv6AddressSection.IPv6StringOptions
along with toNormalizedString(IPAddressSection.IPStringOptions)
.
Or you use one of the methods like Address.toCanonicalString()
which does the same.
For string collections from an address or address section, use IPv4AddressSection.IPv4StringBuilderOptions
, IPv6AddressSection.IPv6StringBuilderOptions
, IPAddressSection.IPStringBuilderOptions
along with toStringCollection(IPAddressSection.IPStringBuilderOptions)
or toStrings(IPAddressSection.IPStringBuilderOptions)
.
Or you use one of the methods toStandardStringCollection()
, toAllStringCollection()
, toStandardStrings()
, toAllStrings()
which does the same.
To construct one from a String
use
IPAddressString.toAddress()
or IPAddressString.getAddress()
, IPAddressString.toHostAddress()
or IPAddressString.getHostAddress()
Modifier and Type | Class and Description |
---|---|
static class |
IPAddress.DualIPv4Pv6Arrays |
static interface |
IPAddress.IPAddressValueProvider |
static class |
IPAddress.IPVersion |
Address.AddressValueProvider, Address.SegmentValueProvider
Modifier and Type | Field and Description |
---|---|
static String |
BINARY_STR_PREFIX |
static IPAddressConverter |
DEFAULT_ADDRESS_CONVERTER
The default way by which addresses are converted, initialized to an instance of
IPAddressConverter.DefaultAddressConverter |
static char |
PREFIX_LEN_SEPARATOR |
ADDRESS_HIGH_VALUE_COMPARATOR, ADDRESS_LOW_VALUE_COMPARATOR, ALTERNATIVE_RANGE_SEPARATOR, ALTERNATIVE_RANGE_SEPARATOR_STR, ALTERNATIVE_SEGMENT_WILDCARD_STR, DEFAULT_ADDRESS_COMPARATOR, HEX_PREFIX, OCTAL_PREFIX, RANGE_SEPARATOR, RANGE_SEPARATOR_STR, SEGMENT_SQL_SINGLE_WILDCARD, SEGMENT_SQL_SINGLE_WILDCARD_STR, SEGMENT_SQL_WILDCARD, SEGMENT_SQL_WILDCARD_STR, SEGMENT_WILDCARD, SEGMENT_WILDCARD_STR
Modifier and Type | Method and Description |
---|---|
abstract IPAddress |
adjustPrefixBySegment(boolean nextSegment)
Increases or decreases prefix length to the next segment boundary.
|
abstract IPAddress |
adjustPrefixBySegment(boolean nextSegment,
boolean zeroed)
Increases or decreases prefix length to the next segment boundary.
|
abstract IPAddress |
adjustPrefixLength(int adjustment)
Increases or decreases prefix length by the given increment.
|
abstract IPAddress |
adjustPrefixLength(int adjustment,
boolean zeroed)
Increases or decreases prefix length by the given increment.
|
abstract IPAddress |
applyPrefixLength(int networkPrefixLength)
Deprecated.
|
<V> V |
applyToBounds(BiFunction<? super IPAddress,? super IPAddress,V> func,
IPAddress... series)
Finds the lowest and highest single-valued address from the given addresses and subnets and this one,
calling the given BiFunction with the lowest as first argument and the highest as second.
|
IPAddress |
assignMinPrefixForBlock()
Constructs an equivalent address with the smallest CIDR prefix possible (largest network),
such that the range of values are a set of subnet blocks for that prefix.
|
IPAddress |
assignPrefixForSingleBlock()
Returns the equivalent CIDR address with a prefix length for which the address subnet block matches the range of values in this address.
|
abstract IPAddress |
bitwiseOr(IPAddress mask)
Equivalent to calling
bitwiseOr(IPAddress, boolean) with the second argument as false. |
abstract IPAddress |
bitwiseOr(IPAddress mask,
boolean retainPrefix)
Does the bitwise disjunction with this address.
|
abstract IPAddress |
bitwiseOrNetwork(IPAddress mask,
int networkPrefixLength)
Does the bitwise disjunction with this address.
|
abstract Iterator<? extends IPAddress> |
blockIterator(int segmentCount)
Iterates through series that can be obtained by iterating through all the upper segments up to the given segment count.
|
abstract AddressComponentSpliterator<? extends IPAddress> |
blockSpliterator(int segmentCount)
Partitions and traverses through the individual sequential blocks created from each of the individual values up to the given segment count.
|
abstract Stream<? extends IPAddress> |
blockStream(int segmentCount)
Returns a sequential stream of the individual blocks created from each of the individual values up to the given segment count.
|
boolean |
contains(IPAddress other)
Returns whether this contains all values of the given address or subnet
|
boolean |
contains(IPAddressSeqRange otherRange)
Returns whether this range contains all addresses in the given sequential range
|
boolean |
containsNonZeroHosts(IPAddress other)
Returns whether this address contains the non-zero host addresses in the other address or subnet
|
abstract IPAddress |
coverWithPrefixBlock(IPAddress other)
Returns the minimal-size prefix block that covers all the addresses spanning from this subnet to the given subnet.
|
abstract BigInteger |
enumerate(IPAddress other)
Indicates where an address sits relative to the subnet ordering.
|
static int |
getBitCount(IPAddress.IPVersion version) |
int |
getBitsPerSegment()
Returns the number of bits comprising each segment in this series.
|
Integer |
getBlockMaskPrefixLength(boolean network)
If this address is equivalent to the mask for a CIDR prefix block, it returns that prefix length.
|
int |
getByteCount()
Provides the number of bytes required for this address item, rounding up if the bit count is not a multiple of 8
|
static int |
getByteCount(IPAddress.IPVersion version) |
int |
getBytesPerSegment()
Returns the number of bytes comprising each segment in this series.
|
IPAddress |
getHostMask()
Returns the host mask associated with the CIDR network prefix length of this series.
|
IPAddress.IPVersion |
getIPVersion()
Returns the version of this segment series
|
abstract Iterable<? extends IPAddress> |
getIterable()
Useful for using an instance in a "for-each loop".
|
int |
getLeadingBitCount(boolean network)
Returns the number of consecutive leading one or zero bits.
|
abstract IPAddress |
getLower()
If this represents a series with ranging values, returns a series representing the lower values of the range.
|
abstract IPAddress |
getLowerNonZeroHost()
Similar to
IPAddressSegmentSeries.getLower() , but will not return a series that has a prefix length and whose host value is zero. |
void |
getMatchesSQLClause(StringBuilder builder,
String sqlExpression)
Returns a clause for matching this address.
|
void |
getMatchesSQLClause(StringBuilder builder,
String sqlExpression,
IPAddressSQLTranslator translator)
Returns a clause for matching this address.
|
int |
getMaxSegmentValue()
Returns the maximum possible segment value for this type of address.
|
abstract IPAddressNetwork<?,?,?,?,?> |
getNetwork()
Returns the network object for components of the same version (eg IPv4, IPv6 and MAC each have their own network object)
|
IPAddress |
getNetworkMask()
Returns the network mask associated with the CIDR network prefix length of this series.
|
Integer |
getNetworkPrefixLength()
Returns the CIDR network prefix length of the series, or null if the series has no associated prefix length.
|
BigInteger |
getNonZeroHostCount()
Gets the count of single value series that this series may represent, but excluding series whose host is zero.
|
IPAddressStringDivisionSeries[] |
getParts(IPAddressSection.IPStringBuilderOptions options)
Returns all the ways of breaking this address down into segments, as selected.
|
IPAddressSection |
getSection()
Returns the address as an address section comprising all segments in the address.
|
IPAddressSection |
getSection(int index)
Gets the subsection from the series starting from the given index
The first segment is at index 0.
|
IPAddressSection |
getSection(int index,
int endIndex)
Gets the subsection from the series starting from the given index and ending just before the give endIndex
The first segment is at index 0.
|
static int |
getSegmentCount(IPAddress.IPVersion version) |
BigInteger |
getSequentialBlockCount()
provides the count of elements from the
IPAddressSegmentSeries.sequentialBlockIterator() , the minimal number of sequential sub-series that comprise this series |
int |
getTrailingBitCount(boolean network)
Returns the number of consecutive trailing one or zero bits.
|
abstract IPAddress |
getUpper()
If this represents a series with ranging values, returns a series representing the upper values of the range.
|
boolean |
includesMaxHost()
Returns whether the series has a host of all ones.
|
boolean |
includesMaxHost(int networkPrefixLength)
Returns whether all bits past the given prefix length are all ones.
|
boolean |
includesZeroHost()
Returns whether the series has a host of zero.
|
boolean |
includesZeroHost(int networkPrefixLength)
Returns whether all bits past the given prefix length are zero.
|
abstract IPAddress |
increment(long increment)
Returns the series from the subnet that is the given increment upwards into the subnet range, with the increment of 0
returning the first address in the range.
|
abstract IPAddress |
incrementBoundary(long increment)
If the given increment is positive, adds the value to the upper series (
AddressSegmentSeries.getUpper() ) in the subnet range to produce a new series. |
abstract IPAddress |
intersect(IPAddress other)
Produces the subnet whose addresses are found in both this and the given subnet argument, or null if no such addresses.
|
boolean |
isAnyLocal()
Returns whether this address is the address which binds to any address on the local host.
|
boolean |
isIPAddress()
Returns whether this address is an IP address
|
boolean |
isIPv4() |
abstract boolean |
isIPv4Convertible()
Determines whether this address can be converted to IPv4, if not IPv4 already.
|
boolean |
isIPv6() |
abstract boolean |
isIPv6Convertible()
Determines whether an address can be converted to IPv6, if not IPv6 already.
|
abstract boolean |
isLinkLocal()
Returns whether the address is link local, whether unicast or multicast.
|
abstract boolean |
isLocal()
Returns true if the address is link local, site local, organization local, administered locally, or unspecified.
|
abstract boolean |
isLoopback() |
boolean |
isSingleNetwork()
Returns true if the network section of the address spans just a single value
|
boolean |
isUnspecified()
The unspecified address is the address that is all zeros.
|
boolean |
isZeroHost()
Returns whether this address has a prefix length and if so, whether the host section is zero for this address or all addresses in this subnet.
|
boolean |
isZeroHost(int networkPrefixLength)
Returns whether the host is zero for the given prefix length for this address or all addresses in this subnet.
|
abstract Iterator<? extends IPAddress> |
iterator()
Iterates through the individual address components.
|
abstract IPAddress |
mask(IPAddress mask)
Equivalent to calling
mask(IPAddress, boolean) with the second argument as false. |
abstract IPAddress |
mask(IPAddress mask,
boolean retainPrefix)
Applies the given mask to all addresses represented by this IPAddress.
|
abstract IPAddress |
maskNetwork(IPAddress mask,
int networkPrefixLength)
Applies the given mask to all addresses represented by this IPAddress while also applying the given prefix length at the same time.
|
boolean |
matches(IPAddressString otherString) |
boolean |
matchesWithMask(IPAddress other,
IPAddress mask)
Applies the mask to this address and then compares values with the given address
|
static IPAddress.DualIPv4Pv6Arrays |
mergeToDualPrefixBlocks(IPAddress... addresses)
merges the given set of IP addresses and subnets into a minimal number of prefix blocks.
|
static IPAddress.DualIPv4Pv6Arrays |
mergeToDualSequentialBlocks(IPAddress... addresses)
merges the given set of IP addresses and subnets into a minimal number of prefix blocks.
|
abstract IPAddress[] |
mergeToPrefixBlocks(IPAddress... addresses)
Merges this with the list of addresses to produce the smallest list of prefix blocks.
|
abstract IPAddress[] |
mergeToSequentialBlocks(IPAddress... addresses)
Merges this with the list of subnets to produce the smallest list of block subnets that are sequential.
|
abstract Iterator<? extends IPAddress> |
nonZeroHostIterator()
Similar to the iterator, but series with a host of zero are skipped.
|
boolean |
overlaps(IPAddress other)
Returns true if this address overlaps the given address or subnet
|
boolean |
overlaps(IPAddressSeqRange other)
Returns true if this address overlaps the given sequential range
|
abstract Iterator<? extends IPAddress> |
prefixBlockIterator()
Iterates through the individual prefix blocks.
|
abstract AddressComponentSpliterator<? extends IPAddress> |
prefixBlockSpliterator()
Partitions and traverses through the individual prefix blocks for the prefix length of this series.
|
abstract Stream<? extends IPAddress> |
prefixBlockStream()
Returns a sequential stream of the individual prefix blocks for the prefix length of this series.
|
boolean |
prefixContains(IPAddress other)
Returns whether the prefix of this address contains all values of the same bits in the given address or subnet
|
abstract Iterator<? extends IPAddress> |
prefixIterator()
Iterates through the individual prefixes.
|
abstract AddressComponentSpliterator<? extends IPAddress> |
prefixSpliterator()
Partitions and traverses through the individual prefixes for the prefix length of this series.
|
abstract Stream<? extends IPAddress> |
prefixStream()
Returns a sequential stream of the individual prefixes for the prefix length of this series.
|
IPAddress |
removeBitCountPrefixLength()
Removes the prefix length from addresses with a prefix length extending to the end of the address.
|
abstract IPAddress |
removePrefixLength()
Deprecated.
|
abstract IPAddress |
removePrefixLength(boolean zeroed)
Deprecated.
|
abstract IPAddress |
reverseBits(boolean perByte)
Returns a new segment series with the bits reversed.
|
abstract IPAddress |
reverseBytes()
Returns a new segment series with the bytes reversed.
|
abstract IPAddress |
reverseBytesPerSegment()
Returns a new segment series with the bytes reversed within each segment.
|
abstract IPAddress |
reverseSegments()
Returns a new segment series with the segments reversed.
|
Iterator<? extends IPAddress> |
sequentialBlockIterator()
Iterates through the sequential series that make up this series.
|
AddressComponentSpliterator<? extends IPAddress> |
sequentialBlockSpliterator()
Partitions and traverses through the individual sequential blocks.
|
Stream<? extends IPAddress> |
sequentialBlockStream()
Returns a sequential stream of the individual sequential blocks.
|
abstract IPAddress |
setPrefixLength(int prefixLength)
Sets the prefix length.
|
abstract IPAddress |
setPrefixLength(int prefixLength,
boolean zeroed)
Sets the prefix length.
|
abstract IPAddress |
setPrefixLength(int prefixLength,
boolean zeroed,
boolean zeroHostIsBlock)
Sets the prefix length while allowing the caller to control whether bits moved in or out of the prefix become zero,
and whether a zero host for the new prefix bits can be translated into a prefix block.
|
abstract IPAddress[] |
spanWithPrefixBlocks(IPAddress other)
Produces the list of prefix block subnets that span from this subnet to the given subnet.
|
abstract IPAddressSeqRange |
spanWithRange(IPAddress other)
Produces an IPAddressRange instance that spans this subnet to the given subnet.
|
abstract IPAddress[] |
spanWithSequentialBlocks(IPAddress other)
Produces a list of sequential block subnets that span all values from this subnet to the given subnet.
|
abstract AddressComponentSpliterator<? extends IPAddress> |
spliterator()
Partitions and traverses through the individual address components.
|
abstract Stream<? extends IPAddress> |
stream()
Returns a sequential stream of the individual address components.
|
abstract IPAddress[] |
subtract(IPAddress other)
Subtract the given subnet from this subnet, returning an array of subnets for the result (the subnets will not be contiguous so an array is required).
|
IPAddressString |
toAddressString()
Generates an IPAddressString object for this IPAddress object.
|
IPAddressPartStringCollection |
toAllStringCollection() |
String[] |
toAllStrings()
Produces almost all possible string variations
|
String |
toBinaryString()
Writes this address as a single binary value with always the exact same number of characters
|
HostName |
toCanonicalHostName()
Does a reverse name lookup to get the canonical host name.
|
String |
toCanonicalWildcardString()
This produces a string similar to the canonical string but avoids the CIDR prefix.
|
String |
toCompressedWildcardString()
This is similar to toNormalizedWildcardString, avoiding the CIDR prefix, but with compression as well.
|
String |
toConvertedString()
Returns a mixed string if it represents a convertible IPv4 address, returns the normalized string otherwise.
|
static String |
toDelimitedSQLStrs(String[] strs) |
String |
toFullString()
This produces a string with no compressed segments and all segments of full length,
which is 4 characters for IPv6 segments and 3 characters for IPv4 segments.
|
HostName |
toHostName()
If this address was resolved from a host, returns that host.
|
InetAddress |
toInetAddress()
Converts the lowest value of this address to an InetAddress
|
IPAddress |
toIPAddress()
If this address is an IP address, returns that
IPAddress . |
IPv4Address |
toIPv4()
If this address is IPv4, or can be converted to IPv4, returns that
IPv4Address . |
IPv6Address |
toIPv6() |
abstract IPAddress |
toMaxHost()
Returns the segment series with a host of all ones.
|
abstract IPAddress |
toMaxHost(int prefixLength)
Produces the series with host values of all one bits for the given prefix length.
|
static String |
toNormalizedString(IPAddress.IPAddressValueProvider provider)
Allows for the creation of a normalized string without creating a full IP address object first.
|
static void |
toNormalizedString(IPAddress.IPAddressValueProvider provider,
StringBuilder builder)
Allows for the creation of a normalized string without creating a full IP address object first.
|
String |
toNormalizedString(IPAddressSection.IPStringOptions params)
Constructs a string representing this address according to the given parameters
|
String |
toNormalizedWildcardString()
This produces a string similar to the normalized string but avoids the CIDR prefix.
|
String |
toOctalString(boolean with0Prefix)
Writes this address as a single octal value with always the exact same number of characters, with or without a preceding 0 prefix.
|
abstract IPAddress |
toPrefixBlock()
Returns the subnet associated with the prefix length of this address.
|
abstract IPAddress |
toPrefixBlock(int networkPrefixLength)
Returns the segment series of the same length that spans all hosts.
|
String |
toPrefixLengthString()
Returns a string with a CIDR network prefix length if this address has a network prefix length.
|
String |
toReverseDNSLookupString()
Generates the reverse DNS lookup string
|
abstract IPAddressSeqRange |
toSequentialRange()
Creates a sequential range instance from the lowest and highest addresses in this subnet
|
abstract IPAddressSeqRange |
toSequentialRange(IPAddress other)
Deprecated.
|
String |
toSQLWildcardString()
This is the same as the string from toNormalizedWildcardString except that
it uses
Address.SEGMENT_SQL_WILDCARD instead of Address.SEGMENT_WILDCARD and also uses Address.SEGMENT_SQL_SINGLE_WILDCARD |
IPAddressPartStringCollection |
toStandardStringCollection() |
String[] |
toStandardStrings()
Returns at most a few dozen string representations:
-mixed (1:2:3:4:5:6:1.2.3.4)
-full compressions (a:0:b:c:d:0:e:f or a::b:c:d:0:e:f or a:0:b:c:d::e:f)
-full leading zeros (000a:0000:000b:000c:000d:0000:000e:000f)
-all uppercase and all lowercase (a::a can be A::A)
-combinations thereof
|
IPAddressPartStringCollection |
toStringCollection(IPAddressSection.IPStringBuilderOptions options) |
String[] |
toStrings(IPAddressSection.IPStringBuilderOptions options)
Rather than using toAllStrings or StandardStrings,
you can use this method to customize the list of strings produced for this address
|
String |
toSubnetString()
Produces a consistent subnet string that looks like 1.2.*.* or 1:2::/16
In the case of IPv4, this means that wildcards are used instead of a network prefix when a network prefix has been supplied.
|
abstract String |
toUNCHostName()
Generates the Microsoft UNC path component for this address
|
InetAddress |
toUpperInetAddress()
Converts the highest value of this address to an InetAddress.
|
abstract IPAddress |
toZeroHost()
Returns the segment series with a host of zero, the host being the bits following the prefix length.
|
abstract IPAddress |
toZeroHost(int prefixLength)
Produces the series with host values of 0 for the given prefix length.
|
abstract IPAddress |
toZeroNetwork()
Returns the segment series with a network of zero, the network being the bits within the prefix length.
|
abstract IPAddress |
withoutPrefixLength()
Provides the same address with no prefix.
|
contains, containsPrefixBlock, containsSinglePrefixBlock, defaultIpv4Network, defaultIpv6Network, defaultMACNetwork, enumerate, equals, getBitCount, getBlockCount, getBytes, getBytes, getBytes, getCount, getDivisionCount, getDivisionStrings, getMinPrefixLengthForBlock, getPrefixCount, getPrefixCount, getPrefixLength, getPrefixLengthForSingleBlock, getSegmentCount, getSegments, getSegments, getSegmentStrings, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, hashCode, includesMax, includesZero, isFullRange, isMACAddress, isMax, isMulticast, isMultiple, isPrefixBlock, isPrefixed, isSameAddress, isSequential, isSinglePrefixBlock, isZero, matchOrdered, matchUnordered, overlaps, prefixEquals, toCanonicalString, toCompressedString, toHexString, toMACAddress, toNormalizedString, toString
coverWithPrefixBlock, getHostSection, getHostSection, getNetworkSection, getNetworkSection, getNetworkSection, getPrefixLenComparator, getSegment, getSegments, segmentsIterator, segmentsNonZeroHostIterator, segmentsSpliterator, segmentsStream, spanWithPrefixBlocks, spanWithSequentialBlocks, toSegmentedBinaryString
getDivision
getPrefixLength, isPrefixBlock, isPrefixed
getSegmentCount, getSegments, getSegments, getSegmentStrings, isOneBit, testBit, toCanonicalString, toCompressedString
getBitCount, getBlockCount, getCount, getDivisionStrings, getPrefixCount, getPrefixCount, getPrefixLength, getSequentialBlockIndex, isMore, isPrefixBlock, isPrefixed, isSequential, isSinglePrefixBlock
getDivisionCount
toHexString, toNormalizedString
stream, stream
compareTo, containsPrefixBlock, containsSinglePrefixBlock, getBitsForCount, getBlockSize, getBytes, getBytes, getBytes, getMinPrefixLengthForBlock, getPrefixLengthForSingleBlock, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isZero
coverWithPrefixBlock, isSequential, prefixBlockIterator, prefixBlockSpliterator, prefixBlockStream, prefixIterator, prefixSpliterator, prefixStream, spanWithPrefixBlocks, spanWithSequentialBlocks, toCanonicalString, toNormalizedString
public static final char PREFIX_LEN_SEPARATOR
public static final String BINARY_STR_PREFIX
public static final IPAddressConverter DEFAULT_ADDRESS_CONVERTER
IPAddressConverter.DefaultAddressConverter
public IPAddressString toAddressString()
This same IPAddress object can be retrieved from the resulting IPAddressString object using IPAddressString.getAddress()
In general, users are intended to create IPAddress objects from IPAddressString objects, while the reverse direction is generally not all that useful.
However, the reverse direction can be useful under certain circumstances.
Not all IPAddressString objects can be converted to IPAddress objects, as is the case with IPAddressString objects corresponding to the types IPType.INVALID and IPType.EMPTY.
Not all IPAddressString objects can be converted to IPAddress objects without specifying the IP version, as is the case with IPAddressString objects corresponding to the types IPType.PREFIX and IPType.ALL.
So in the event you wish to store a collection of IPAddress objects with a collection of IPAddressString objects, and not all the IPAddressString objects can be converted to IPAddress objects, then you may wish to use a collection of only IPAddressString objects, in which case this method is useful.
toAddressString
in class Address
public HostName toHostName()
public HostName toCanonicalHostName()
InetAddress.getCanonicalHostName()
In particular, on some systems the loopback address has canonical host localhost and on others the canonical host is the same loopback address.public abstract IPAddressNetwork<?,?,?,?,?> getNetwork()
AddressComponent
getNetwork
in interface AddressComponent
getNetwork
in interface IPAddressStringDivisionSeries
getNetwork
in interface IPAddressSegmentSeries
public IPAddressSection getSection()
getSection
in interface AddressSegmentSeries
getSection
in interface IPAddressSegmentSeries
getSection
in class Address
public IPAddressSection getSection(int index)
AddressSegmentSeries
getSection
in interface AddressSegmentSeries
getSection
in interface IPAddressSegmentSeries
public IPAddressSection getSection(int index, int endIndex)
AddressSegmentSeries
getSection
in interface AddressSegmentSeries
getSection
in interface IPAddressSegmentSeries
public IPAddressStringDivisionSeries[] getParts(IPAddressSection.IPStringBuilderOptions options)
public int getMaxSegmentValue()
AddressSegmentSeries
getMaxSegmentValue
in interface AddressSegmentSeries
public BigInteger getNonZeroHostCount()
IPAddressSegmentSeries
If this address series has no range of values, then there is only one such address, or none if it has a zero host.
If this has no CIDR network prefix length, then it is equivalent to AddressDivisionSeries.getCount()
.
getNonZeroHostCount
in interface IPAddressSegmentSeries
public int getBytesPerSegment()
AddressSegmentSeries
getBytesPerSegment
in interface AddressSegmentSeries
public int getBitsPerSegment()
AddressSegmentSeries
getBitsPerSegment
in interface AddressSegmentSeries
public int getByteCount()
AddressItem
getByteCount
in interface AddressItem
getByteCount
in class Address
public static int getByteCount(IPAddress.IPVersion version)
public static int getSegmentCount(IPAddress.IPVersion version)
public static int getBitCount(IPAddress.IPVersion version)
public <V> V applyToBounds(BiFunction<? super IPAddress,? super IPAddress,V> func, IPAddress... series)
For instance, given the IPv4 addresses 1.2.0.0/16 and 1.3.4.5, the lowest is 1.2.0.0 and the highest is 1.3.4.5. Given the addresses 1.2.0.0/16 and 1.1.4.5, the lowest is 1.1.4.5 and the highest is 1.2.255.255.
If one of the given addresses or subnets is a different version than this,
then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
This can be useful for methods that require a range as input,
like spanWithPrefixBlocks(IPAddress)
, spanWithSequentialBlocks(IPAddress)
,
coverWithPrefixBlock(IPAddress)
, or toSequentialRange(IPAddress)
.
For instance, to cover multiple addresses with a prefix block:
IPAddress coveringAddress = address0.applyToBounds(IPAddress::coverWithPrefixBlock, address1, address2, address3, ...);
public abstract IPAddress getLowerNonZeroHost()
IPAddressSegmentSeries
IPAddressSegmentSeries.getLower()
, but will not return a series that has a prefix length and whose host value is zero.
If this series has no prefix length, returns the same series as IPAddressSegmentSeries.getLower()
.getLowerNonZeroHost
in interface IPAddressSegmentSeries
public abstract IPAddress getLower()
AddressSegmentSeries
getLower
in interface AddressSegmentSeries
getLower
in interface AddressComponentRange
getLower
in interface IPAddressRange
getLower
in interface IPAddressSegmentSeries
getLower
in class Address
public abstract IPAddress getUpper()
AddressSegmentSeries
getUpper
in interface AddressSegmentSeries
getUpper
in interface AddressComponentRange
getUpper
in interface IPAddressRange
getUpper
in interface IPAddressSegmentSeries
getUpper
in class Address
public abstract IPAddress reverseBits(boolean perByte)
AddressSegmentSeries
reverseBits
in interface AddressComponent
reverseBits
in interface AddressSegmentSeries
reverseBits
in interface IPAddressSegmentSeries
reverseBits
in class Address
perByte
- if true, only the bits in each byte are reversed, if false, then all bits in the component are reversedpublic abstract IPAddress reverseBytes()
AddressSegmentSeries
reverseBytes
in interface AddressComponent
reverseBytes
in interface AddressSegmentSeries
reverseBytes
in interface IPAddressSegmentSeries
reverseBytes
in class Address
public abstract IPAddress reverseBytesPerSegment()
AddressSegmentSeries
reverseBytesPerSegment
in interface AddressSegmentSeries
reverseBytesPerSegment
in interface IPAddressSegmentSeries
reverseBytesPerSegment
in class Address
public abstract IPAddress reverseSegments()
AddressSegmentSeries
IncompatibleAddressException
since all address series can reverse their segments.reverseSegments
in interface AddressSegmentSeries
reverseSegments
in interface IPAddressSegmentSeries
reverseSegments
in class Address
public abstract Iterator<? extends IPAddress> iterator()
AddressComponentRange
An address component can represent an individual segment, address, or section, or it can represent multiple, typically a subnet of addresses or a range of segment or section values.
Call AddressItem.isMultiple()
to determine if this instance represents multiple, or AddressItem.getCount()
for the count.
iterator
in interface AddressSegmentSeries
iterator
in interface AddressComponentRange
iterator
in interface IPAddressRange
iterator
in interface IPAddressSegmentSeries
iterator
in class Address
public abstract AddressComponentSpliterator<? extends IPAddress> spliterator()
AddressComponentRange
spliterator
in interface AddressComponent
spliterator
in interface AddressSegmentSeries
spliterator
in interface AddressComponentRange
spliterator
in interface IPAddressRange
spliterator
in interface IPAddressSegmentSeries
spliterator
in class Address
public abstract Stream<? extends IPAddress> stream()
AddressComponentRange
BaseStream.parallel()
on the returned stream.stream
in interface AddressSegmentSeries
stream
in interface AddressComponentRange
stream
in interface IPAddressSegmentSeries
stream
in class Address
public abstract Iterator<? extends IPAddress> nonZeroHostIterator()
IPAddressSegmentSeries
nonZeroHostIterator
in interface IPAddressSegmentSeries
public abstract Iterator<? extends IPAddress> prefixIterator()
AddressSegmentSeries
If the series has no prefix length, then this is equivalent to AddressSegmentSeries.iterator()
prefixIterator
in interface AddressSegmentSeries
prefixIterator
in interface IPAddressSegmentSeries
prefixIterator
in class Address
public abstract AddressComponentSpliterator<? extends IPAddress> prefixSpliterator()
AddressSegmentSeries
prefixSpliterator
in interface AddressSegmentSeries
prefixSpliterator
in interface IPAddressSegmentSeries
prefixSpliterator
in class Address
public abstract Stream<? extends IPAddress> prefixStream()
AddressSegmentSeries
BaseStream.parallel()
on the returned stream.prefixStream
in interface AddressSegmentSeries
prefixStream
in interface IPAddressSegmentSeries
prefixStream
in class Address
public abstract Iterator<? extends IPAddress> prefixBlockIterator()
AddressSegmentSeries
If the series has no prefix length, then this is equivalent to AddressSegmentSeries.iterator()
prefixBlockIterator
in interface AddressSegmentSeries
prefixBlockIterator
in interface IPAddressSegmentSeries
prefixBlockIterator
in class Address
public abstract AddressComponentSpliterator<? extends IPAddress> prefixBlockSpliterator()
AddressSegmentSeries
prefixBlockSpliterator
in interface AddressSegmentSeries
prefixBlockSpliterator
in interface IPAddressSegmentSeries
prefixBlockSpliterator
in class Address
public abstract Stream<? extends IPAddress> prefixBlockStream()
AddressSegmentSeries
BaseStream.parallel()
on the returned stream.prefixBlockStream
in interface AddressSegmentSeries
prefixBlockStream
in interface IPAddressSegmentSeries
prefixBlockStream
in class Address
public abstract Iterator<? extends IPAddress> blockIterator(int segmentCount)
IPAddressSegmentSeries
For instance, given the IPv4 subnet 1-2.3-4.5-6.7, given the count argument 2, it will iterate through 1.3.5-6.7, 1.4.5-6.7, 2.3.5-6.7, 2.4.5-6.7
blockIterator
in interface IPAddressSegmentSeries
public abstract AddressComponentSpliterator<? extends IPAddress> blockSpliterator(int segmentCount)
IPAddressSegmentSeries
blockSpliterator
in interface IPAddressSegmentSeries
public abstract Stream<? extends IPAddress> blockStream(int segmentCount)
IPAddressSegmentSeries
BaseStream.parallel()
on the returned stream.blockStream
in interface IPAddressSegmentSeries
public Iterator<? extends IPAddress> sequentialBlockIterator()
IPAddressSegmentSeries
IPAddressSegmentSeries.blockIterator(int)
with that segment count.
For instance, given the IPv4 subnet 1-2.3-4.5-6.7-8, it will iterate through 1.3.5.7-8, 1.3.6.7-8, 1.4.5.7-8, 1.4.6.7-8, 2.3.5.7-8, 2.3.6.7-8, 2.4.6.7-8, 2.4.6.7-8.
Use IPAddressSegmentSeries.getSequentialBlockCount()
to get the count of iterated elements.
sequentialBlockIterator
in interface IPAddressSegmentSeries
public AddressComponentSpliterator<? extends IPAddress> sequentialBlockSpliterator()
IPAddressSegmentSeries
sequentialBlockSpliterator
in interface IPAddressSegmentSeries
public Stream<? extends IPAddress> sequentialBlockStream()
IPAddressSegmentSeries
BaseStream.parallel()
on the returned stream.
Use IPAddressSegmentSeries.getSequentialBlockCount()
to get the count of streamed elements.
sequentialBlockStream
in interface IPAddressSegmentSeries
public BigInteger getSequentialBlockCount()
IPAddressSegmentSeries
IPAddressSegmentSeries.sequentialBlockIterator()
, the minimal number of sequential sub-series that comprise this seriesgetSequentialBlockCount
in interface IPAddressSegmentSeries
public abstract Iterable<? extends IPAddress> getIterable()
AddressComponentRange
AddressComponentRange.iterator()
directly.getIterable
in interface AddressSegmentSeries
getIterable
in interface AddressComponentRange
getIterable
in interface IPAddressRange
getIterable
in interface IPAddressSegmentSeries
getIterable
in class Address
public abstract IPAddress increment(long increment) throws AddressValueException
AddressSegmentSeries
If the subnet has multiple values and the increment exceeds the subnet size, then the amount by which it exceeds the size - 1 is added to the upper series of the range (the final iterator value).
If the increment is negative, it is added to the lower series of the range (the first iterator value).
If the subnet is just a single address values, the series is simply incremented by the given value, positive or negative.
If a subnet has multiple values, a positive increment value is equivalent to the same number of values from the AddressSegmentSeries.iterator()
For instance, a increment of 0 is the first value from the iterator, an increment of 1 is the second value from the iterator, and so on.
A negative increment added to the subnet count is equivalent to the same number of values preceding the upper bound of the iterator.
For instance, an increment of count - 1 is the last value from the iterator, an increment of count - 2 is the second last value, and so on.
An increment of size count gives you the series just above the highest series of the subnet. To get the series just below the lowest series of the subnet, use the increment -1.
increment
in interface AddressSegmentSeries
increment
in interface IPAddressSegmentSeries
increment
in class Address
AddressValueException
- in case of underflow or overflowpublic abstract IPAddress incrementBoundary(long increment) throws AddressValueException
AddressSegmentSeries
AddressSegmentSeries.getUpper()
) in the subnet range to produce a new series.
If the given increment is negative, adds the value to the lower series (AddressSegmentSeries.getLower()
) in the subnet range to produce a new series.
If the increment is zero, returns this.
In the case where the series is a single value, this simply returns the address produced by adding the given increment to this address series.
incrementBoundary
in interface AddressSegmentSeries
incrementBoundary
in interface IPAddressSegmentSeries
incrementBoundary
in class Address
AddressValueException
- in case of underflow or overflowpublic boolean isIPAddress()
Address
isIPAddress
in class Address
public IPAddress toIPAddress()
Address
IPAddress
. Otherwise, returns null.toIPAddress
in class Address
public boolean isIPv4()
public boolean isIPv6()
public IPAddress.IPVersion getIPVersion()
IPAddressSegmentSeries
getIPVersion
in interface IPAddressSegmentSeries
public IPv4Address toIPv4()
IPv4Address
. Otherwise, returns null.isIPv4Convertible()
public IPv6Address toIPv6()
IPv6Address
. Otherwise, returns null.isIPv6Convertible()
public abstract boolean isIPv4Convertible()
IPv6Address.isIPv4Mapped()
You should also override toIPv4()
to match the conversion.
This method returns true for all IPv4 addresses.public abstract boolean isIPv6Convertible()
IPv4Address.getIPv4MappedAddress()
You should also override toIPv6()
to match the conversion.
This method returns true for all IPv6 addresses.public abstract boolean isLinkLocal()
InetAddress.isLinkLocalAddress()
public abstract boolean isLocal()
public boolean isUnspecified()
public boolean isAnyLocal()
InetAddress.isAnyLocalAddress()
public abstract boolean isLoopback()
InetAddress.isLoopbackAddress()
public InetAddress toUpperInetAddress()
toInetAddress()
public InetAddress toInetAddress()
public abstract IPAddressSeqRange toSequentialRange()
The two will represent the same set of individual addresses if and only if Address.isSequential()
is true.
To get a series of ranges that represent the same set of individual addresses use the sequentialBlockIterator()
(or prefixIterator()
),
and apply this method to each iterated subnet.
If this represents just a single address then the returned instance covers just that single address as well.
toSequentialRange
in interface IPAddressRange
@Deprecated public abstract IPAddressSeqRange toSequentialRange(IPAddress other) throws AddressConversionException
spanWithRange(IPAddress)
If the other address is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
When you have multiple subnets, create a range from lowest to highest with:
IPAddressSeqRange range = subnet0.applyToBounds(IPAddress::toSequentialRange, subnet1, subnet2, ...);
See applyToBounds(java.util.function.BiFunction, IPAddress...)
other
- AddressConversionException
public boolean matches(IPAddressString otherString)
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)
Implements the same method in IPAddressRange
.
contains
in interface IPAddressRange
other
- public boolean containsNonZeroHosts(IPAddress other)
other
- public abstract BigInteger enumerate(IPAddress other)
For more details, see the equivalent method Address.enumerate(Address)
.
This method satisfies the implementation of IPAddressRange
.
enumerate
in interface IPAddressRange
public boolean prefixContains(IPAddress other)
other
- public boolean isZeroHost()
public boolean isZeroHost(int networkPrefixLength)
public boolean contains(IPAddressSeqRange otherRange)
IPAddressRange
contains
in interface IPAddressRange
public boolean matchesWithMask(IPAddress other, IPAddress mask)
mask
- other
- public static void toNormalizedString(IPAddress.IPAddressValueProvider provider, StringBuilder builder)
IPAddress.IPAddressValueProvider
interface in whatever way is most efficient.
The string is appended to the provided StringBuilder
instance.provider
- builder
- public static String toNormalizedString(IPAddress.IPAddressValueProvider provider)
IPAddress.IPAddressValueProvider
interface in whatever way is most efficient.provider
- public String toFullString()
toFullString
in interface IPAddressSegmentSeries
public String toSubnetString()
toSubnetString
in interface IPAddressSegmentSeries
public String toNormalizedWildcardString()
toNormalizedWildcardString
in interface IPAddressSegmentSeries
public String toCanonicalWildcardString()
toCanonicalWildcardString
in interface IPAddressSegmentSeries
public String toCompressedWildcardString()
toCompressedWildcardString
in interface IPAddressSegmentSeries
public String toSQLWildcardString()
Address.SEGMENT_SQL_WILDCARD
instead of Address.SEGMENT_WILDCARD
and also uses Address.SEGMENT_SQL_SINGLE_WILDCARD
toSQLWildcardString
in interface IPAddressSegmentSeries
public String toPrefixLengthString()
toPrefixLengthString
in interface IPAddressSegmentSeries
public String toConvertedString()
public abstract String toUNCHostName()
public String toReverseDNSLookupString()
For 8.255.4.4 it is 4.4.255.8.in-addr.arpa
For 2001:db8::567:89ab it is b.a.9.8.7.6.5.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa
toReverseDNSLookupString
in interface IPAddressSegmentSeries
IncompatibleAddressException
- if this address is a subnetpublic String toBinaryString() throws IncompatibleAddressException
If this section represents a range of values not corresponding to a prefix, then this is printed as a range of two hex values.
toBinaryString
in interface IPAddressSegmentSeries
IncompatibleAddressException
public String toOctalString(boolean with0Prefix) throws IncompatibleAddressException
If this section represents a range of values not corresponding to a prefix, then this is printed as a range of two hex values.
toOctalString
in interface IPAddressSegmentSeries
IncompatibleAddressException
public String toNormalizedString(IPAddressSection.IPStringOptions params)
toNormalizedString
in interface IPAddressSegmentSeries
params
- the parameters for the address stringIncompatibleAddressException
- for cases in which the requested string cannot be produced, which can generally only occur with specific strings from specific subnets.public String[] toStandardStrings()
public String[] toAllStrings()
Use this method with care... a single IPv6 address can have thousands of string representations.
Examples:
Variations included in this method:
toStandardStrings()
public String[] toStrings(IPAddressSection.IPStringBuilderOptions options)
public IPAddressPartStringCollection toStandardStringCollection()
public IPAddressPartStringCollection toAllStringCollection()
public IPAddressPartStringCollection toStringCollection(IPAddressSection.IPStringBuilderOptions options)
toStringCollection
in interface IPAddressSegmentSeries
public Integer getNetworkPrefixLength()
IPAddressDivisionSeries
Equivalent to AddressDivisionSeries.getPrefixLength()
,
which is the more general concept of set of address series that share the same set of leading bits.
For IP addresses and sections the prefix length and the CIDR network prefix length are the same thing.
For IP addresses and sections each individual segment has an associated prefix length which is determine by the network prefix length. The segment prefix lengths follow the pattern: null, null, ...., null, x, 0, 0, ..., 0
For instance, an IPv4 address 1.2.3.4/16 has the network prefix length 16. The segment prefix lengths are [null, 8, 0, 0] The segment prefix lengths of 1.2.3.4/22 are [null, null, 6, 0]
getNetworkPrefixLength
in interface IPAddressDivisionSeries
public IPAddress getHostMask()
IPAddressSegmentSeries
getHostMask
in interface IPAddressSegmentSeries
public IPAddress getNetworkMask()
IPAddressSegmentSeries
getNetworkMask
in interface IPAddressSegmentSeries
public boolean includesZeroHost()
IPAddressSegmentSeries
includesZeroHost
in interface IPAddressSegmentSeries
public boolean includesZeroHost(int networkPrefixLength)
IPAddressSegmentSeries
includesZeroHost
in interface IPAddressSegmentSeries
public abstract IPAddress toZeroHost(int prefixLength)
IPAddressSegmentSeries
If this series has the same prefix length, then the resulting series will too, otherwise the resulting series will have no prefix length.
This is nearly equivalent to doing the mask (bitwise conjunction) of this address series with the network mask for the given prefix length, but without the possibility of IncompatibleAddressException that can occur when applying a mask to a range of values. Instead, in this case, if the resulting series has a range of values, then the resulting series range boundaries will have host values of 0, but not necessarily the intervening values.
For instance, you can get the network address for a subnet of prefix length 16 as follows:
String addrStr = "1.2.3.4";
IPAddress address = new IPAddressString(addrStr).getAddress();
IPAddress networkAddress = address.toZeroHost(16); //1.2.0.0
toZeroHost
in interface IPAddressSegmentSeries
public abstract IPAddress toZeroHost()
IPAddressSegmentSeries
The default behaviour is that the resultant series will have the same prefix length.
The resultant series will not have a prefix length if AddressNetwork.getPrefixConfiguration()
is AddressNetwork.PrefixConfiguration.ALL_PREFIXED_ADDRESSES_ARE_SUBNETS
.
For instance, you can get the network address for a subnet as follows:
String addrStr = "1.2.3.4/16";
IPAddress address = new IPAddressString(addrStr).getAddress();
IPAddress networkAddress = address.toZeroHost(); //1.2.0.0
toZeroHost
in interface IPAddressSegmentSeries
IPAddressSegmentSeries.toZeroNetwork()
public abstract IPAddress toZeroNetwork()
IPAddressSegmentSeries
The default behaviour is that the resultant series will have the same prefix length.
The resultant series will not have a prefix length if AddressNetwork.getPrefixConfiguration()
is AddressNetwork.PrefixConfiguration.ALL_PREFIXED_ADDRESSES_ARE_SUBNETS
.
toZeroNetwork
in interface IPAddressSegmentSeries
IPAddressSegmentSeries.toZeroHost()
public abstract IPAddress toMaxHost(int prefixLength)
IPAddressSegmentSeries
If this series has the same prefix length, then the resulting series will too, otherwise the resulting series will have no prefix length.
This is nearly equivalent to doing the bitwise or (bitwise disjunction) of this address series with the network mask for the given prefix length, but without the possibility of IncompatibleAddressException that can occur when applying a mask to a range of values. Instead, in this case, if the resulting series has a range of values, then the resulting series range boundaries will have host values of all ones, but not necessarily the intervening values.
For instance, you can get the broadcast address for a subnet of prefix length 16 as follows:
String addrStr = "1.2.3.4";
IPAddress address = new IPAddressString(addrStr).getAddress();
IPAddress broadcastAddress = address.toMaxHost(16); //1.2.255.255
toMaxHost
in interface IPAddressSegmentSeries
public abstract IPAddress toMaxHost()
IPAddressSegmentSeries
The resultant series will have the same prefix length if AddressNetwork.getPrefixConfiguration()
is not AddressNetwork.PrefixConfiguration.ALL_PREFIXED_ADDRESSES_ARE_SUBNETS
,
otherwise it will no longer have a prefix length.
For instance, you can get the broadcast address for a subnet as follows:
String addrStr = "1.2.3.4/16";
IPAddress address = new IPAddressString(addrStr).getAddress();
IPAddress broadcastAddress = address.toMaxHost(); //1.2.255.255
toMaxHost
in interface IPAddressSegmentSeries
public boolean includesMaxHost()
IPAddressSegmentSeries
includesMaxHost
in interface IPAddressSegmentSeries
public boolean includesMaxHost(int networkPrefixLength)
IPAddressSegmentSeries
includesMaxHost
in interface IPAddressSegmentSeries
public boolean isSingleNetwork()
For example, return true for 1.2.3.4/16 and false for 1.2-3.3.4/16
public abstract IPAddress toPrefixBlock()
For example, if the address is 1.2.3.4/16 it returns the subnet 1.2.*.* /16
toPrefixBlock
in interface AddressSegmentSeries
toPrefixBlock
in interface IPAddressSegmentSeries
toPrefixBlock
in class Address
public abstract IPAddress toPrefixBlock(int networkPrefixLength) throws PrefixLenException
IPAddressSegmentSeries
toPrefixBlock
in interface IPAddressSegmentSeries
PrefixLenException
public IPAddress assignPrefixForSingleBlock()
If no such prefix length exists, returns null.
Examples:
1.2.3.4 returns 1.2.3.4/32
1.2.*.* returns 1.2.0.0/16
1.2.*.0/24 returns 1.2.0.0/16
1.2.*.4 returns null
1.2.252-255.* returns 1.2.252.0/22
1.2.3.4/x returns the same address
assignPrefixForSingleBlock
in interface IPAddressSegmentSeries
IPAddressSegmentSeries.toPrefixBlock()
,
IPAddressSegmentSeries.assignMinPrefixForBlock()
public IPAddress assignMinPrefixForBlock()
assignMinPrefixForBlock
in interface IPAddressSegmentSeries
IPAddressSegmentSeries.toPrefixBlock()
,
IPAddressSegmentSeries.assignPrefixForSingleBlock()
public Integer getBlockMaskPrefixLength(boolean network)
Also, keep in mind that the prefix length returned by this method is not equivalent to the prefix length used to construct this object. The prefix length used to construct indicates the network and host section of this address. The prefix length returned here indicates the whether the value of this address can be used as a mask for the network and host section of any other address. Therefore the two values can be different values, or one can be null while the other is not.
Just like the mask methods which use the lower value for masking, this method applies only to the lower value of the range if this address represents multiple values.
network
- whether to check if we are a network mask or a host maskpublic int getTrailingBitCount(boolean network)
This method applies only to the lower value of the range if this address represents multiple values.
network
- public int getLeadingBitCount(boolean network)
This method applies only to the lower value of the range if this address represents multiple values.
network
- public abstract IPAddress coverWithPrefixBlock(IPAddress other) throws AddressConversionException
If the other address is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
When you have multiple subnets, cover with:
IPAddress block = subnet0.applyToBounds(IPAddress::coverWithPrefixBlock, subnet1, subnet2, ...);
See applyToBounds(java.util.function.BiFunction, IPAddress...)
AddressConversionException
public abstract IPAddress[] spanWithPrefixBlocks(IPAddress other) throws AddressConversionException
If the other address is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
The resulting array is sorted from lowest address value to highest, regardless of the size of each prefix block.
From the list of returned subnets you can recover the original range (this to other) by converting each to IPAddressRange with toSequentialRange()
and them joining them into a single range with IPAddressSeqRange.join(IPAddressSeqRange...)
When you have multiple subnets, span with:
IPAddress blocks[] = subnet0.applyToBounds(IPAddress::spanWithPrefixBlocks, subnet1, subnet2, ...);
See applyToBounds(java.util.function.BiFunction, IPAddress...)
other
- AddressConversionException
public abstract IPAddress[] spanWithSequentialBlocks(IPAddress other) throws AddressConversionException
Individual block subnets come in the form 1-3.1-4.5.6-8, however that particular subnet is not sequential since address 1.1.5.8 is in the subnet, the next sequential address 1.1.5.9 is not in the subnet, and a higher address 1.2.5.6 is in the subnet. Blocks are sequential when the first segment with a range of values is followed by segments that span all values.
If the other address is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
The resulting array is sorted from lowest address value to highest, regardless of the size of each prefix block.
From the list of returned subnets you can recover the original range (this and other) by converting each to IPAddressRange with toSequentialRange()
and them joining them into a single range with IPAddressSeqRange.join(IPAddressSeqRange...)
When you have multiple subnets, span with:
IPAddress blocks[] = subnet0.applyToBounds(IPAddress::spanWithSequentialBlocks, subnet1, subnet2, ...);
See applyToBounds(java.util.function.BiFunction, IPAddress...)
other
- AddressConversionException
public abstract IPAddressSeqRange spanWithRange(IPAddress other) throws AddressConversionException
If the other address is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
When you have multiple subnets, span with:
IPAddressSeqRange range = subnet0.applyToBounds(IPAddress::spanWithRange, subnet1, subnet2, ...);
See applyToBounds(java.util.function.BiFunction, IPAddress...)
other
- AddressConversionException
public abstract IPAddress[] mergeToPrefixBlocks(IPAddress... addresses) throws AddressConversionException
For the smallest list of subnets use mergeToSequentialBlocks(IPAddress...)
.
If any other address in the list is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
,
which can result in AddressConversionException
The resulting array is sorted from lowest address value to highest, regardless of the size of each prefix block.
In version 5.3.1 and earlier, the result was sorted from single address to smallest blocks to largest blocks.
For that ordering, sort with IPAddressSegmentSeries.getPrefixLenComparator()
:
Arrays.sort(result, IPAddressSegmentSeries.getPrefixLenComparator());
The merging process works with sequential blocks. CIDR prefix subnets have just a single sequential block, as does individual addresses. So this method works efficiently for most conventionally-used subnets.
For example, the subnet ::*:*:*:1-ffff has 281474976710656 sequential blocks.
Just like you should avoid iterating through such a large number of blocks,
you should avoid using this method to merge such a subnet,
rather than a subnet like ::1-ffff:*:*:*:* which has 1 sequential block,
or the subnet ::1-ffff:1-ffff:*:*:*:* which has 65535 sequential blocks.
You can use getSequentialBlockCount()
to get the sequential block count.
There are alternatives ways to merge into prefix blocks available in this library. Typically this method is most efficient when merging CIDR prefix blocks and/or individual addresses, which is likely to be the case for most users most of the time. It converts to CIDR prefix blocks prior to merging, if not CIDR prefix blocks or individual addresses already.
When merging a large number of blocks that are not prefix blocks nor individual addresses,
it may be more efficient to merge first and then convert to CIDR prefix blocks afterwards.
You can use mergeToSequentialBlocks(IPAddress...)
to merge,
and then span each merged element in the result with IPAddressSegmentSeries.spanWithPrefixBlocks()
,
giving the same result as this method.
Sequential ranges provide another option.
You can convert to sequential blocks first with sequentialBlockIterator()
,
then convert each sequential block to IPAddressSeqRange
with toSequentialRange()
,
then join those sequential ranges with IPAddressSeqRange.join(IPAddressSeqRange...)
,
then convert them to CIDR prefix blocks with IPAddressSeqRange.spanWithPrefixBlocks()
,
giving the same result as this method.
addresses
- the addresses to merge with thisAddressConversionException
public static IPAddress.DualIPv4Pv6Arrays mergeToDualSequentialBlocks(IPAddress... addresses)
addresses
- public static IPAddress.DualIPv4Pv6Arrays mergeToDualPrefixBlocks(IPAddress... addresses)
addresses
- public abstract IPAddress[] mergeToSequentialBlocks(IPAddress... addresses) throws AddressConversionException
Block subnets come in the form 1-3.1-4.5.6-8, however that subnet is not sequential since address 1.1.5.8 is in the subnet, the next sequential address 1.1.5.9 is not in the subnet, and a higher address 1.2.5.6 is in the subnet. Blocks are sequential when the first segment with a range of values is followed by segments that span all values.
This list will eliminate overlaps to produce the smallest list of sequential block subnets, which is the same size or smaller than the list of prefix blocks produced by mergeToPrefixBlocks(IPAddress...)
If the incoming blocks are not sequential, the result could be a longer list, since the list is divided into sequential blocks before merging.
If any other address in the list is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
,
which can result in AddressConversionException
The resulting array is sorted by lower address, regardless of the size of each prefix block.
In version 5.3.1 and earlier, the result was sorted from single address to smallest blocks to largest blocks.
For that ordering, sort with IPAddressSegmentSeries.getPrefixLenComparator()
:
Arrays.sort(result, IPAddressSegmentSeries.getPrefixLenComparator());
See the javadoc for mergeToPrefixBlocks(IPAddress...)
for some alternatives for merging subnets.
addresses
- the addresses to merge with thisAddressConversionException
public abstract IPAddress intersect(IPAddress other) throws AddressConversionException
This is also known as the conjunction of the two sets of addresses.
If the address is not the same version, the default conversion will be applied using toIPv4()
or toIPv6()
, and it that fails, AddressConversionException
will be thrown.
other
- AddressConversionException
- if the address argument could not be converted to the same address version as thispublic abstract IPAddress[] subtract(IPAddress other) throws AddressConversionException
Computes the subnet difference, the set of addresses in this address subnet but not in the provided subnet. This is also known as the relative complement of the given argument in this subnet.
If the address is not the same version, the default conversion will be applied using toIPv4()
or toIPv6()
, and it that fails, AddressConversionException
will be thrown.
other
- AddressConversionException
- if the address argument could not be converted to the same address version as thispublic abstract IPAddress mask(IPAddress mask) throws AddressConversionException, IncompatibleAddressException
mask(IPAddress, boolean)
with the second argument as false.
If the mask is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
mask
- IncompatibleAddressException
- if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segmentAddressConversionException
- if the address argument could not be converted to the same address version as thispublic abstract IPAddress mask(IPAddress mask, boolean retainPrefix) throws AddressConversionException, IncompatibleAddressException
If the mask is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
If this represents multiple addresses, and applying the mask to all addresses creates a set of addresses
that cannot be represented as a contiguous range within each segment, then IncompatibleAddressException
is thrown.
mask
- IncompatibleAddressException
- if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segmentAddressConversionException
- if the address argument could not be converted to the same address version as thispublic abstract IPAddress maskNetwork(IPAddress mask, int networkPrefixLength) throws AddressConversionException, IncompatibleAddressException
Any existing prefix length is removed as the mask and new prefix length is applied to all individual addresses.
If the mask is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
If this represents multiple addresses, and applying the mask to all addresses creates a set of addresses
that cannot be represented as a contiguous range within each segment, then IncompatibleAddressException
is thrown.
IncompatibleAddressException
- if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segmentAddressConversionException
- if the address argument could not be converted to the same address version as thispublic abstract IPAddress bitwiseOr(IPAddress mask) throws AddressConversionException, IncompatibleAddressException
bitwiseOr(IPAddress, boolean)
with the second argument as false.
If the mask is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
mask
- AddressConversionException
- if the address argument could not be converted to the same address version as thisIncompatibleAddressException
- if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segmentpublic abstract IPAddress bitwiseOr(IPAddress mask, boolean retainPrefix) throws AddressConversionException, IncompatibleAddressException
The mask is applied to all individual addresses, similar to how the method mask(IPAddress, boolean)
applies the bitwise conjunction.
Any existing prefix length is removed beforehand. If the retainPrefix argument is true, then the existing prefix length will be applied to the result.
If the mask is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
If you wish to mask a section of the network, use bitwiseOrNetwork(IPAddress, int)
For instance, you can get the broadcast address for a subnet as follows:
String addrStr = "1.2.3.4/16";
IPAddress address = new IPAddressString(addrStr).getAddress();
IPAddress hostMask = address.getNetwork().getHostMask(address.getNetworkPrefixLength());//0.0.255.255
IPAddress broadcastAddress = address.bitwiseOr(hostMask); //1.2.255.255
mask
- retainPrefix
- AddressConversionException
- if the address argument could not be converted to the same address version as thisIncompatibleAddressException
- if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segmentpublic abstract IPAddress bitwiseOrNetwork(IPAddress mask, int networkPrefixLength) throws AddressConversionException, IncompatibleAddressException
If the mask is a different version than this, then the default conversion is applied to the other address first using toIPv4()
or toIPv6()
Any existing prefix length is dropped for the new prefix length and the mask is applied up to the end the new prefix length.
It is similar to how the maskNetwork(IPAddress, int)
method does the bitwise conjunction.
mask
- networkPrefixLength
- the new prefix length for the addressIncompatibleAddressException
- if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segmentAddressConversionException
- if the address argument could not be converted to the same address version as this@Deprecated public abstract IPAddress removePrefixLength()
AddressSegmentSeries
If the series already has a prefix length, the bits outside the prefix become zero.
Use AddressSegmentSeries.withoutPrefixLength()
to remove the prefix length without changing the series values.
Equivalent to calling removePrefixLength(true)
removePrefixLength
in interface AddressSegmentSeries
removePrefixLength
in interface IPAddressSegmentSeries
removePrefixLength
in class Address
for an alternative which does not change the address series values.
@Deprecated public abstract IPAddress removePrefixLength(boolean zeroed)
AddressSegmentSeries
AddressSegmentSeries.removePrefixLength()
removePrefixLength
in interface AddressSegmentSeries
removePrefixLength
in interface IPAddressSegmentSeries
removePrefixLength
in class Address
zeroed
- whether the bits outside the prefix become zeropublic abstract IPAddress withoutPrefixLength()
AddressSegmentSeries
Use AddressSegmentSeries.removePrefixLength()
as an alternative that deletes the host at the same time by zeroing the host values.
withoutPrefixLength
in interface AddressSegmentSeries
withoutPrefixLength
in interface IPAddressSegmentSeries
withoutPrefixLength
in class Address
public abstract IPAddress adjustPrefixBySegment(boolean nextSegment)
AddressSegmentSeries
Follows the same rules as AddressSegmentSeries.adjustPrefixLength(int)
:
When prefix length is increased, the bits moved within the prefix become zero.
When a prefix length is decreased, the bits moved outside the prefix become zero.
To avoid the zeroing behaviour, use AddressSegmentSeries.adjustPrefixBySegment(boolean, boolean)
with second arg false.
adjustPrefixBySegment
in interface AddressSegmentSeries
adjustPrefixBySegment
in interface IPAddressSegmentSeries
adjustPrefixBySegment
in class Address
nextSegment
- whether to move prefix to previous or following segment boundarypublic abstract IPAddress adjustPrefixBySegment(boolean nextSegment, boolean zeroed)
AddressSegmentSeries
adjustPrefixBySegment
in interface AddressSegmentSeries
adjustPrefixBySegment
in interface IPAddressSegmentSeries
adjustPrefixBySegment
in class Address
nextSegment
- whether to move prefix to previous or following segment boundaryzeroed
- whether the bits that move from one side of the prefix to the other become zero or retain their original valuespublic abstract IPAddress adjustPrefixLength(int adjustment)
When prefix length is increased, the bits moved within the prefix become zero.
When the prefix is extended beyond the segment series boundary, it is removed.
When a prefix length is decreased, the bits moved outside the prefix become zero,
and if the entire host address contains the zero address,
then the resulting address is determined AddressNetwork.getPrefixConfiguration()
.
For example, 1.2.0.0/16 adjusted by -8 becomes 1.0.0.0/8.
1.2.0.0/16 adjusted by 8 becomes 1.2.0.0/24
adjustPrefixLength
in interface AddressSegmentSeries
adjustPrefixLength
in interface IPAddressSegmentSeries
adjustPrefixLength
in class Address
adjustment
- public abstract IPAddress adjustPrefixLength(int adjustment, boolean zeroed)
AddressSegmentSeries
adjustPrefixLength
in interface AddressSegmentSeries
adjustPrefixLength
in interface IPAddressSegmentSeries
adjustPrefixLength
in class Address
adjustment
- the incrementzeroed
- whether the bits that move from one side of the prefix to the other become zero or retain their original valuespublic abstract IPAddress setPrefixLength(int prefixLength)
AddressSegmentSeries
If this series has a prefix length, and the prefix length is increased, the bits moved within the prefix become zero.
For an alternative that does not set bits to zero, use AddressSegmentSeries.setPrefixLength(int, boolean)
with the second argument as false.
When the prefix is extended beyond the segment series boundary, it is removed.
The bits that move from one side of the prefix length to the other (ie bits moved into the prefix or outside the prefix) are zeroed.
setPrefixLength
in interface AddressSegmentSeries
setPrefixLength
in interface IPAddressSegmentSeries
setPrefixLength
in class Address
public abstract IPAddress setPrefixLength(int prefixLength, boolean zeroed)
AddressSegmentSeries
When the prefix is extended beyond the segment series boundary, it is removed.
setPrefixLength
in interface AddressSegmentSeries
setPrefixLength
in interface IPAddressSegmentSeries
setPrefixLength
in class Address
zeroed
- whether the bits that move from one side of the prefix length to the other (ie bits moved into the prefix or outside the prefix) are zeroed.public abstract IPAddress setPrefixLength(int prefixLength, boolean zeroed, boolean zeroHostIsBlock)
setPrefixLength(int, boolean)
and setPrefixLength(int)
use a value of true for zeroed and for zeroHostIsBlock.
For example, when zeroHostIsBlock is true, applying to 1.2.0.0 the prefix length 16 results in 1.2.*.*/16
Or if you start with 1.2.0.0/24, setting the prefix length to 16 results in a zero host followed by the existing prefix block, which is then converted to a full prefix block, 1.2.*.*/16
When both zeroed and zeroHostIsBlock are true, applying the prefiix length of 16 to 1.2.4.0/24 also results in a zero host followed by the existing prefix block, which is then converted to a full prefix block, 1.2.*.*/16.
When both zeroed and zeroHostIsBlock are false, the resulting address always encompasses the same set of addresses as the original, albeit with a different prefix length.
prefixLength
- zeroed
- zeroHostIsBlock
- @Deprecated public abstract IPAddress applyPrefixLength(int networkPrefixLength)
AddressSegmentSeries
Similar to AddressSegmentSeries.setPrefixLength(int)
except that prefix lengths are never increased.
When this series already has a prefix length that is less than or equal to the requested prefix length, this series is returned.
Otherwise the returned series has the given prefix length.
The bits moved outside the prefix will become zero in the returned series.
applyPrefixLength
in interface AddressSegmentSeries
applyPrefixLength
in interface IPAddressSegmentSeries
applyPrefixLength
in class Address
AddressSegmentSeries.setPrefixLength(int)
public void getMatchesSQLClause(StringBuilder builder, String sqlExpression)
If this address is a subnet, this method will attempt to match every address in the subnet. Therefore it is much more efficient to use getNetworkSection().getStartsWithSQLClause() for a CIDR subnet.
builder
- sqlExpression
- public void getMatchesSQLClause(StringBuilder builder, String sqlExpression, IPAddressSQLTranslator translator)
Similar to getMatchesSQLClause(StringBuilder builder, String sqlExpression) but allows you to tailor the SQL produced.
builder
- sqlExpression
- translator
- public IPAddress removeBitCountPrefixLength()