public class IPv4AddressSection extends IPAddressSection implements java.lang.Iterable<IPv4AddressSection>
Modifier and Type | Class and Description |
---|---|
static class |
IPv4AddressSection.IPv4StringBuilderOptions |
static class |
IPv4AddressSection.IPv4StringOptions
Represents a clear way to create a specific type of string.
|
IPAddressSection.IPStringBuilderOptions, IPAddressSection.IPStringOptions, IPAddressSection.SegFunction<R,S>, IPAddressSection.SeriesCreator, IPAddressSection.WildcardOptions
Constructor and Description |
---|
IPv4AddressSection(Address.SegmentValueProvider lowerValueProvider,
Address.SegmentValueProvider upperValueProvider,
int segmentCount) |
IPv4AddressSection(Address.SegmentValueProvider lowerValueProvider,
Address.SegmentValueProvider upperValueProvider,
int segmentCount,
java.lang.Integer networkPrefixLength) |
IPv4AddressSection(Address.SegmentValueProvider valueProvider,
int segmentCount) |
IPv4AddressSection(Address.SegmentValueProvider valueProvider,
int segmentCount,
java.lang.Integer networkPrefixLength) |
IPv4AddressSection(byte[] bytes) |
IPv4AddressSection(byte[] bytes,
java.lang.Integer prefix) |
IPv4AddressSection(byte[] bytes,
int byteStartIndex,
int byteEndIndex) |
IPv4AddressSection(byte[] bytes,
int byteStartIndex,
int byteEndIndex,
java.lang.Integer prefix) |
IPv4AddressSection(int value) |
IPv4AddressSection(int value,
java.lang.Integer networkPrefixLength) |
IPv4AddressSection(IPv4AddressSegment segment)
Constructs a single segment section.
|
IPv4AddressSection(IPv4AddressSegment[] segments) |
IPv4AddressSection(IPv4AddressSegment[] segments,
java.lang.Integer networkPrefixLength) |
Modifier and Type | Method and Description |
---|---|
IPv4AddressSection |
adjustPrefixBySegment(boolean nextSegment)
Increases or decreases prefix length to the next segment boundary.
|
IPv4AddressSection |
adjustPrefixBySegment(boolean nextSegment,
boolean zeroed)
Increases or decreases prefix length to the next segment boundary.
|
IPv4AddressSection |
adjustPrefixLength(int adjustment)
Increases or decreases prefix length by the given increment.
|
IPv4AddressSection |
adjustPrefixLength(int adjustment,
boolean zeroed)
Increases or decreases prefix length by the given increment.
|
IPv4AddressSection |
append(IPv4AddressSection other) |
IPv4AddressSection |
appendToNetwork(IPv4AddressSection other) |
IPv4AddressSection |
applyPrefixLength(int networkPrefixLength)
Applies the given prefix length to create a new segment series.
|
IPv4AddressSection |
assignMinPrefixForBlock()
Constructs an equivalent address section with the smallest CIDR prefix possible (largest network),
such that the range of values are a set of subnet blocks for that prefix.
|
IPv4AddressSection |
assignPrefixForSingleBlock()
Returns the equivalent CIDR address section with a prefix length for which the subnet block for that prefix matches the range of values in this section.
|
IPv4AddressSection |
bitwiseOr(IPv4AddressSection mask)
Equivalent to
bitwiseOr(IPv4AddressSection, boolean) with the second argument as false. |
IPv4AddressSection |
bitwiseOr(IPv4AddressSection mask,
boolean retainPrefix)
Does the bitwise disjunction with this address section.
|
IPv4AddressSection |
bitwiseOrNetwork(IPv4AddressSection mask,
int networkPrefixLength)
Does the bitwise disjunction with this address section.
|
java.util.Iterator<IPv4AddressSection> |
blockIterator(int segmentCount)
Iterates through series that can be obtained by iterating through all the upper segments up to the given segment count.
|
boolean |
contains(AddressSection other)
Determines if one section contains another.
|
IPv4AddressSection |
createMaxHost() |
boolean |
equals(java.lang.Object o)
Two groupings are equal if:
- they match type/version (ipv4, ipv6, mac, or a specific grouping class)
- they match division counts
- each division matches bit counts
- each division matches their specific grouping class
- each division matches values
Prefix lengths, for those groupings and/or divisionsS that have them, are ignored.
|
int |
getBitCount() |
int |
getBitsPerSegment()
Returns the number of bits comprising each segment in this series.
|
int |
getByteCount() |
int |
getBytesPerSegment()
Returns the number of bytes comprising each segment in this series.
|
IPv4AddressSegment |
getDivision(int index) |
IPv4AddressSection |
getHostSection()
Returns the host section of the series.
|
IPv4AddressSection |
getHostSection(int networkPrefixLength)
Returns the host section of the address as indicated by the network prefix length provided.
|
long |
getIPv4Count(boolean excludeZeroHosts) |
long |
getIPv4PrefixCount() |
long |
getIPv4PrefixCount(int prefixLength) |
IPAddress.IPVersion |
getIPVersion()
Returns the version of this segment series
|
java.lang.Iterable<IPv4AddressSection> |
getIterable()
Useful for using an instance in a "for-each loop".
|
IPv4AddressSection |
getLower()
If this represents a series with ranging values, returns a series representing the lower values of the range.
|
IPv4AddressSection |
getLowerNonZeroHost()
Similar to
IPAddressSegmentSeries.getLower() , but will not return a series that has a prefix length and whose host value is zero. |
IPv4AddressNetwork |
getNetwork()
Returns the network object for series of the same version (eg IPv4, IPv6 and MAC each have their own network object)
|
IPv4AddressSection |
getNetworkSection()
Returns the network section of the series if the series has a CIDR network prefix length,
otherwise it returns the entire series as a prefixed series with prefix matching the address bit length.
|
IPv4AddressSection |
getNetworkSection(int networkPrefixLength)
Returns the network section of the series.
|
IPv4AddressSection |
getNetworkSection(int networkPrefixLength,
boolean withPrefixLength)
Returns the network section of the series.
|
inet.ipaddr.format.string.IPAddressStringDivisionSeries[] |
getParts(IPAddressSection.IPStringBuilderOptions options)
Get all representations of this address including this IPAddressSection.
|
inet.ipaddr.format.string.IPAddressStringDivisionSeries[] |
getParts(IPv4AddressSection.IPv4StringBuilderOptions options) |
java.math.BigInteger |
getPrefixCount(int prefixLength)
The count of the number of distinct values within the prefix part of the address item, the bits that appear within the prefix length.
|
IPv4AddressSection |
getSection()
Gets the subsection from the series that comprises all segments
|
IPv4AddressSection |
getSection(int index)
Gets the subsection from the series starting from the given index
|
IPv4AddressSection |
getSection(int index,
int endIndex)
Gets the subsection from the series starting from the given index and ending just before the give endIndex
|
IPv4AddressSegment |
getSegment(int index)
Returns the segment from this series at the given index.
|
IPv4AddressSegment[] |
getSegments()
Returns the segments of this series of segments as an array.
|
void |
getSegments(java.util.Collection<? super IPv4AddressSegment> segs) |
void |
getSegments(int start,
int end,
java.util.Collection<? super IPv4AddressSegment> segs) |
IPv4AddressSection |
getUpper()
If this represents a series with ranging values, returns a series representing the upper values of the range
If this represents a series with a single value in each segment, returns this.
|
IPv4AddressSection |
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.
|
IPv4AddressSection |
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. |
IPv4AddressSection |
insert(int index,
IPv4AddressSection other) |
IPv4AddressSection |
intersect(IPv4AddressSection other)
Produces the subnet sections whose addresses are found in both this and the given argument.
|
int |
intValue() |
boolean |
isIPv4() |
java.util.Iterator<IPv4AddressSection> |
iterator()
Iterates through the individual segment series.
|
long |
longValue() |
IPv4AddressSection |
mask(IPv4AddressSection mask)
Equivalent to
mask(IPv4AddressSection, boolean) with the second argument as false. |
IPv4AddressSection |
mask(IPv4AddressSection mask,
boolean retainPrefix)
Does the bitwise conjunction with this address.
|
IPv4AddressSection |
maskNetwork(IPv4AddressSection mask,
int networkPrefixLength)
Produces the bitwise conjunction of the given mask with the network section of the address as indicated by the given prefix length.
|
boolean |
matchesWithMask(IPAddressSection other,
IPAddressSection mask)
Applies the mask to this address section and then compares values with the given address section
|
IPv4AddressSection[] |
mergePrefixBlocks(IPv4AddressSection... sections)
Merges this with the list of sections to produce the smallest array of prefix blocks, going from smallest to largest
|
IPv4AddressSection[] |
mergeToSequentialBlocks(IPv4AddressSection... sections)
Merges this with the list of sections to produce the smallest array of sequential block subnets, going from smallest to largest
|
java.util.Iterator<IPv4AddressSection> |
nonZeroHostIterator()
Similar to the prefix block iterator, but series with a host of zero are skipped.
|
java.util.Iterator<IPv4AddressSection> |
prefixBlockIterator()
Iterates through the individual prefix blocks.
|
boolean |
prefixEquals(AddressSection other)
Determines if the argument section matches this section up to the prefix length of this section.
|
java.util.Iterator<IPv4AddressSection> |
prefixIterator()
Iterates through the individual prefixes.
|
IPv4AddressSection |
removePrefixLength()
Removes the prefix length.
|
IPv4AddressSection |
removePrefixLength(boolean zeroed)
Removes the prefix length.
|
IPv4AddressSection |
replace(int startIndex,
int endIndex,
IPv4AddressSection replacement,
int replacementStartIndex,
int replacementEndIndex)
Replaces segments starting from startIndex and ending before endIndex with the segments starting at replacementStartIndex and
ending before replacementEndIndex from the replacement section
|
IPv4AddressSection |
replace(int index,
IPv4AddressSection other)
Replace the segments of this section starting at the given index with the given replacement segments
|
IPv4AddressSection |
reverseBits(boolean perByte)
Returns a new series which has the bits reversed.
|
IPv4AddressSection |
reverseBytes()
Returns a new segment series with the bytes reversed.
|
IPv4AddressSection |
reverseBytesPerSegment()
Returns a new segment series with the bytes reversed within each segment.
|
IPv4AddressSection |
reverseSegments()
Returns a new segment series with the segments reversed.
|
java.util.Iterator<IPv4AddressSegment[]> |
segmentsIterator()
Iterates through the individual segments.
|
java.util.Iterator<IPv4AddressSegment[]> |
segmentsNonZeroHostIterator()
Similar to the segments iterator, but series with a host of zero are skipped.
|
java.util.Iterator<IPv4AddressSection> |
sequentialBlockIterator()
Iterates through the sequential series that make up this series.
|
IPv4AddressSection |
setPrefixLength(int networkPrefixLength)
Sets the prefix length.
|
IPv4AddressSection |
setPrefixLength(int networkPrefixLength,
boolean withZeros)
Sets the prefix length.
|
IPv4AddressSection[] |
spanWithPrefixBlocks(IPv4AddressSection other)
Produces the list of prefix block subnets that span from this series to the given series.
|
IPv4AddressSection[] |
spanWithRangedSegments(IPv4AddressSection other)
Produces a list of range subnets that span from this series to the given series.
|
IPv4AddressSection[] |
subtract(IPv4AddressSection other)
Subtract the given subnet from this subnet, returning an array of sections for the result (the subnets will not be contiguous so an array is required).
|
IPAddressPartStringCollection |
toAllStringCollection()
Use this method with care...
|
java.lang.String |
toCanonicalString()
This produces a canonical string.
|
java.lang.String |
toCanonicalWildcardString()
This produces a string similar to the canonical string and avoids the CIDR prefix.
|
java.lang.String |
toCompressedString()
The shortest string for IPv4 addresses is the same as the canonical string.
|
java.lang.String |
toCompressedWildcardString()
This is similar to toNormalizedWildcardString, avoiding the CIDR prefix, but with compression as well.
|
IPAddressPartStringCollection |
toDatabaseSearchStringCollection()
Returns a set of strings for search the standard string representations in a database
-compress the largest compressible segments or no compression (a:0:0:c:d:0:e:f or a::c:d:0:e:f)
-upper/lowercase is not considered because many databases are case-insensitive
|
java.lang.String |
toFullString()
This produces a string with no compressed segments and all segments of full length,
which is 3 characters for IPv4 segments.
|
java.lang.String |
toInetAtonString(IPv4Address.inet_aton_radix radix) |
java.lang.String |
toInetAtonString(IPv4Address.inet_aton_radix radix,
int joinedCount) |
inet.ipaddr.format.standard.IPAddressDivisionGrouping |
toJoinedSegments(int joinCount) |
IPv4AddressSection |
toMaxHost()
Returns the segment series with a host of all ones.
|
IPv4AddressSection |
toMaxHost(int prefixLength)
Produces the series with host values of all one bits for the given prefix length.
|
java.lang.String |
toNormalizedString()
The normalized string returned by this method is consistent with java.net.Inet4Address,
and is the same as
toCanonicalString() . |
java.lang.String |
toNormalizedString(IPAddressSection.IPStringOptions stringParams,
int joinCount) |
java.lang.String |
toNormalizedWildcardString()
This produces a string similar to the normalized string and avoids the CIDR prefix.
|
IPv4AddressSection |
toPrefixBlock()
If this series has a prefix length, returns the subnet block for that prefix.
|
IPv4AddressSection |
toPrefixBlock(int networkPrefixLength)
Returns the segment series of the same length that spans all hosts.
|
java.lang.String |
toPrefixLengthString()
Returns a string with a CIDR prefix length if this section has a network prefix length.
|
java.lang.String |
toReverseDNSLookupString()
Generates the reverse DNS lookup string
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
|
java.lang.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()
Returns at most a couple dozen string representations:
-mixed (1:2:3:4:5:6:1.2.3.4)
-upper and lower case
-full compressions or no compression (a:0:0:c:d:0:e:f or a::c:d:0:e:f or a:0:b:c:d::e:f)
-full leading zeros (000a:0000:000b:000c:000d:0000:000e:000f)
-combinations thereof
|
IPAddressPartStringCollection |
toStringCollection(IPAddressSection.IPStringBuilderOptions opts) |
IPAddressPartStringCollection |
toStringCollection(IPv4AddressSection.IPv4StringBuilderOptions opts) |
java.lang.String |
toSubnetString()
Produces a consistent subnet string.
|
IPv4AddressSection |
toZeroHost()
Returns the segment series with a host of zero.
|
IPv4AddressSection |
toZeroHost(int prefixLength)
Produces the series with host values of 0 for the given prefix length.
|
int |
upperIntValue() |
long |
upperLongValue() |
IPv4AddressSection |
withoutPrefixLength()
Provides the same address with no prefix.
|
bitsPerSegment, bytesPerSegment, containsPrefixBlock, getBlockCount, getBlockMaskPrefixLength, getCountImpl, getMaxSegmentValue, getMinPrefixLengthForBlock, getNonZeroHostCount, getPrefixLengthForSingleBlock, getSegmentCount, getSegments, getSegments, getSegmentStrings, getSequentialBlockCount, getStartsWithSQLClause, getStartsWithSQLClause, includesMaxHost, includesMaxHost, includesZeroHost, includesZeroHost, isEntireAddress, isFullRange, isIPv6, isSingleNetwork, toBinaryString, toHexString, toNormalizedString, toNormalizedString, toOctalString, toString
containsSinglePrefixBlock, getNetworkPrefixLength, getPrefixLength, getZeroRangeSegments, getZeroSegments, isMore, isPrefixBlock, isSinglePrefixBlock
getBytes, getBytes, getBytes, getCount, getDivisionCount, getDivisionStrings, getPrefixCount, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isMax, isMultiple, isPrefixed, isZero
getNetworkPrefixLength
getPrefixLength, isPrefixBlock, isPrefixed
getCount, getDivisionStrings, getPrefixCount, getPrefixLength, isMore, isPrefixBlock, isPrefixed, isSequential, isSinglePrefixBlock
public IPv4AddressSection(IPv4AddressSegment segment)
segment
- public IPv4AddressSection(IPv4AddressSegment[] segments) throws AddressValueException
AddressValueException
public IPv4AddressSection(IPv4AddressSegment[] segments, java.lang.Integer networkPrefixLength) throws AddressValueException
segments
- an array containing the segments. Segments that are entirely part of the host section need not be provided, although the array must be the correct length.networkPrefixLength
- AddressValueException
public IPv4AddressSection(Address.SegmentValueProvider valueProvider, int segmentCount, java.lang.Integer networkPrefixLength) throws AddressValueException
AddressValueException
public IPv4AddressSection(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, int segmentCount, java.lang.Integer networkPrefixLength) throws AddressValueException
AddressValueException
public IPv4AddressSection(Address.SegmentValueProvider valueProvider, int segmentCount) throws AddressValueException
AddressValueException
public IPv4AddressSection(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, int segmentCount)
public IPv4AddressSection(byte[] bytes, java.lang.Integer prefix) throws AddressValueException
AddressValueException
public IPv4AddressSection(byte[] bytes) throws AddressValueException
AddressValueException
public IPv4AddressSection(byte[] bytes, int byteStartIndex, int byteEndIndex, java.lang.Integer prefix) throws AddressValueException
AddressValueException
public IPv4AddressSection(byte[] bytes, int byteStartIndex, int byteEndIndex) throws AddressValueException
AddressValueException
public IPv4AddressSection(int value, java.lang.Integer networkPrefixLength) throws AddressValueException
AddressValueException
public IPv4AddressSection(int value)
public IPv4AddressSegment[] getSegments()
AddressSegmentSeries
AddressSegmentSeries.getSegment(int)
and AddressSegmentSeries.getSegmentCount()
instead when feasible.getSegments
in interface AddressSegmentSeries
getSegments
in interface IPAddressSegmentSeries
public IPv4AddressSection getSection()
AddressSegmentSeries
getSection
in interface AddressSegmentSeries
getSection
in interface IPAddressSegmentSeries
public IPv4AddressSection getSection(int index)
AddressSegmentSeries
getSection
in interface AddressSegmentSeries
getSection
in interface IPAddressSegmentSeries
getSection
in class IPAddressSection
public IPv4AddressSection getSection(int index, int endIndex)
AddressSegmentSeries
getSection
in interface AddressSegmentSeries
getSection
in interface IPAddressSegmentSeries
getSection
in class IPAddressSection
public IPv4AddressSection 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
getLowerNonZeroHost
in class IPAddressSection
public IPv4AddressSection getLower()
AddressSegmentSeries
getLower
in interface AddressComponent
getLower
in interface AddressSection
getLower
in interface AddressSegmentSeries
getLower
in interface AddressItemRange
getLower
in interface IPAddressSegmentSeries
getLower
in class IPAddressSection
public IPv4AddressSection getUpper()
AddressSegmentSeries
getUpper
in interface AddressComponent
getUpper
in interface AddressSection
getUpper
in interface AddressSegmentSeries
getUpper
in interface AddressItemRange
getUpper
in interface IPAddressSegmentSeries
getUpper
in class IPAddressSection
public int intValue()
public int upperIntValue()
public long longValue()
public long upperLongValue()
public IPv4AddressSection reverseBits(boolean perByte)
IPAddressSegmentSeries
If this has an associated prefix length, then the prefix length is dropped in the reversed series.
If this represents a range of values that cannot be reversed,
because reversing the range results in a set of addresses that cannot be described by a range, then this throws IncompatibleAddressException
.
In such cases you can call IPAddressSegmentSeries.iterator()
, IPAddressSegmentSeries.getLower()
, IPAddressSegmentSeries.getUpper()
or some other method to transform the address
into an address representing a single value before reversing.
reverseBits
in interface AddressComponent
reverseBits
in interface AddressSection
reverseBits
in interface AddressSegmentSeries
reverseBits
in interface IPAddressSegmentSeries
reverseBits
in class IPAddressSection
perByte
- if true, only the bits in each byte are reversed, if false, then all bits in the address are reversedpublic IPv4AddressSection reverseBytes()
AddressSegmentSeries
reverseBytes
in interface AddressComponent
reverseBytes
in interface AddressSection
reverseBytes
in interface AddressSegmentSeries
reverseBytes
in interface IPAddressSegmentSeries
reverseBytes
in class IPAddressSection
public IPv4AddressSection reverseBytesPerSegment()
AddressSegmentSeries
reverseBytesPerSegment
in interface AddressSection
reverseBytesPerSegment
in interface AddressSegmentSeries
reverseBytesPerSegment
in interface IPAddressSegmentSeries
reverseBytesPerSegment
in class IPAddressSection
public IPv4AddressSection reverseSegments()
AddressSegmentSeries
IncompatibleAddressException
since all address series can reverse their segments.reverseSegments
in interface AddressSection
reverseSegments
in interface AddressSegmentSeries
reverseSegments
in interface IPAddressSegmentSeries
reverseSegments
in class IPAddressSection
public java.lang.Iterable<IPv4AddressSection> getIterable()
AddressItemRange
AddressItemRange.iterator()
directly.getIterable
in interface AddressComponent
getIterable
in interface AddressSection
getIterable
in interface AddressSegmentSeries
getIterable
in interface AddressItemRange
getIterable
in interface IPAddressSegmentSeries
getIterable
in class IPAddressSection
public java.util.Iterator<IPv4AddressSection> nonZeroHostIterator()
IPAddressSegmentSeries
nonZeroHostIterator
in interface IPAddressSegmentSeries
nonZeroHostIterator
in class IPAddressSection
public java.util.Iterator<IPv4AddressSection> iterator()
AddressSegmentSeries
iterator
in interface AddressComponent
iterator
in interface AddressSection
iterator
in interface AddressSegmentSeries
iterator
in interface AddressItemRange
iterator
in interface IPAddressSegmentSeries
iterator
in interface java.lang.Iterable<IPv4AddressSection>
iterator
in class IPAddressSection
public java.util.Iterator<IPv4AddressSection> prefixIterator()
AddressSegmentSeries
AddressSegmentSeries.iterator()
prefixIterator
in interface AddressSection
prefixIterator
in interface AddressSegmentSeries
prefixIterator
in interface IPAddressSegmentSeries
prefixIterator
in class IPAddressSection
public java.util.Iterator<IPv4AddressSection> prefixBlockIterator()
AddressSegmentSeries
AddressSegmentSeries.iterator()
prefixBlockIterator
in interface AddressSection
prefixBlockIterator
in interface AddressSegmentSeries
prefixBlockIterator
in interface IPAddressSegmentSeries
prefixBlockIterator
in class IPAddressSection
public java.util.Iterator<IPv4AddressSection> 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
blockIterator
in class IPAddressSection
public java.util.Iterator<IPv4AddressSection> 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
sequentialBlockIterator
in interface IPAddressSegmentSeries
sequentialBlockIterator
in class IPAddressSection
public java.util.Iterator<IPv4AddressSegment[]> segmentsNonZeroHostIterator()
IPAddressSegmentSeries
segmentsNonZeroHostIterator
in interface IPAddressSegmentSeries
public java.util.Iterator<IPv4AddressSegment[]> segmentsIterator()
AddressSegmentSeries
segmentsIterator
in interface AddressSegmentSeries
segmentsIterator
in interface IPAddressSegmentSeries
public IPv4AddressSection incrementBoundary(long increment)
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 AddressSection
incrementBoundary
in interface AddressSegmentSeries
incrementBoundary
in interface IPAddressSegmentSeries
incrementBoundary
in class IPAddressSection
public IPv4AddressSection increment(long increment)
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 AddressSection
increment
in interface AddressSegmentSeries
increment
in interface IPAddressSegmentSeries
increment
in class IPAddressSection
public long getIPv4Count(boolean excludeZeroHosts)
public long getIPv4PrefixCount(int prefixLength)
public java.math.BigInteger getPrefixCount(int prefixLength)
AddressItem
getPrefixCount
in interface AddressDivisionSeries
getPrefixCount
in interface AddressItem
public long getIPv4PrefixCount()
public IPv4AddressSegment getDivision(int index)
getDivision
in interface AddressDivisionSeries
getDivision
in interface IPAddressDivisionSeries
getDivision
in interface inet.ipaddr.format.string.AddressStringDivisionSeries
getDivision
in interface inet.ipaddr.format.string.IPAddressStringDivisionSeries
getDivision
in class IPAddressSection
public IPv4AddressSegment getSegment(int index)
AddressSegmentSeries
getSegment
in interface AddressSegmentSeries
getSegment
in interface IPAddressSegmentSeries
getSegment
in class IPAddressSection
public void getSegments(java.util.Collection<? super IPv4AddressSegment> segs)
public void getSegments(int start, int end, java.util.Collection<? super IPv4AddressSegment> segs)
public int getBitsPerSegment()
AddressSegmentSeries
getBitsPerSegment
in interface AddressSegmentSeries
public int getBytesPerSegment()
AddressSegmentSeries
getBytesPerSegment
in interface AddressSegmentSeries
public int getBitCount()
getBitCount
in interface AddressDivisionSeries
getBitCount
in interface AddressItem
getBitCount
in class IPAddressSection
public int getByteCount()
getByteCount
in interface AddressItem
getByteCount
in class IPAddressSection
public boolean isIPv4()
isIPv4
in class IPAddressSection
public IPAddress.IPVersion getIPVersion()
IPAddressSegmentSeries
getIPVersion
in interface IPAddressSegmentSeries
public boolean matchesWithMask(IPAddressSection other, IPAddressSection mask)
IPAddressSection
matchesWithMask
in class IPAddressSection
public boolean equals(java.lang.Object o)
AddressDivisionGroupingBase
equals
in class inet.ipaddr.format.standard.IPAddressDivisionGrouping
public boolean contains(AddressSection other)
AddressSection
Sections must have the same number of segments to be comparable.
For sections which are aware of their position in an address (IPv6 and MAC), their respective positions must match to be comparable.
contains
in interface AddressSection
contains
in class IPAddressSection
public boolean prefixEquals(AddressSection other)
AddressSection
The entire prefix of this section must be present in the other section to be comparable.
For sections which are aware of their position in an address (IPv6 and MAC), the argument section must have the same or an earlier position in the address to match all prefix segments of this section, and the matching is lined up relative to the position.
prefixEquals
in interface AddressSection
public IPv4AddressSection append(IPv4AddressSection other)
public IPv4AddressSection insert(int index, IPv4AddressSection other)
public IPv4AddressSection replace(int index, IPv4AddressSection other)
index
- other
- public IPv4AddressSection appendToNetwork(IPv4AddressSection other)
public IPv4AddressSection replace(int startIndex, int endIndex, IPv4AddressSection replacement, int replacementStartIndex, int replacementEndIndex)
startIndex
- endIndex
- replacement
- replacementStartIndex
- replacementEndIndex
- java.lang.IndexOutOfBoundsException
IncompatibleAddressException
- if the resulting section would exceed the maximum segment count for this address type and versionpublic IPv4AddressSection intersect(IPv4AddressSection other) throws SizeMismatchException
This is also known as the conjunction of the two sets of address sections.
other
- SizeMismatchException
public IPv4AddressSection[] subtract(IPv4AddressSection other) throws SizeMismatchException
Computes the subnet difference, the set of addresses in this address section but not in the provided section. This is also known as the relative complement of the given argument in this subnet.
Keep in mind this is set subtraction, not subtraction of segment values. We have a subnet of addresses and we are removing some of those addresses.
other
- SizeMismatchException
- if the two sections are different sizespublic IPv4AddressNetwork getNetwork()
AddressSegmentSeries
getNetwork
in interface AddressSegmentSeries
getNetwork
in interface inet.ipaddr.format.string.IPAddressStringDivisionSeries
getNetwork
in interface IPAddressSegmentSeries
getNetwork
in class inet.ipaddr.format.standard.IPAddressDivisionGrouping
public IPv4AddressSection 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.
adjustPrefixBySegment
in interface AddressSection
adjustPrefixBySegment
in interface AddressSegmentSeries
adjustPrefixBySegment
in interface IPAddressSegmentSeries
adjustPrefixBySegment
in class IPAddressSection
nextSegment
- whether to move prefix to previous or following segment coundarypublic IPv4AddressSection adjustPrefixBySegment(boolean nextSegment, boolean zeroed)
AddressSegmentSeries
adjustPrefixBySegment
in interface AddressSection
adjustPrefixBySegment
in interface AddressSegmentSeries
adjustPrefixBySegment
in interface IPAddressSegmentSeries
adjustPrefixBySegment
in class IPAddressSection
nextSegment
- whether to move prefix to previous or following segment coundaryzeroed
- whether the bits that move from one side of the prefix to the other become zero or retain their original valuespublic IPv4AddressSection adjustPrefixLength(int adjustment)
AddressSegmentSeries
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.
adjustPrefixLength
in interface AddressSection
adjustPrefixLength
in interface AddressSegmentSeries
adjustPrefixLength
in interface IPAddressSegmentSeries
adjustPrefixLength
in class IPAddressSection
public IPv4AddressSection adjustPrefixLength(int adjustment, boolean zeroed)
AddressSegmentSeries
adjustPrefixLength
in interface AddressSection
adjustPrefixLength
in interface AddressSegmentSeries
adjustPrefixLength
in interface IPAddressSegmentSeries
adjustPrefixLength
in class IPAddressSection
adjustment
- the incrementzeroed
- whether the bits that move from one side of the prefix to the other become zero or retain their original valuespublic IPv4AddressSection 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 AddressSection
applyPrefixLength
in interface AddressSegmentSeries
applyPrefixLength
in interface IPAddressSegmentSeries
applyPrefixLength
in class IPAddressSection
AddressSegmentSeries.setPrefixLength(int)
public IPv4AddressSection setPrefixLength(int networkPrefixLength)
AddressSegmentSeries
If this series has a prefix length, and the 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.
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 AddressSection
setPrefixLength
in interface AddressSegmentSeries
setPrefixLength
in interface IPAddressSegmentSeries
setPrefixLength
in class IPAddressSection
AddressSegmentSeries.applyPrefixLength(int)
public IPv4AddressSection setPrefixLength(int networkPrefixLength, boolean withZeros)
AddressSegmentSeries
When the prefix is extended beyond the segment series boundary, it is removed.
setPrefixLength
in interface AddressSection
setPrefixLength
in interface AddressSegmentSeries
setPrefixLength
in interface IPAddressSegmentSeries
setPrefixLength
in class IPAddressSection
withZeros
- 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 IPv4AddressSection removePrefixLength()
IPAddressSegmentSeries
removePrefixLength
in interface AddressSection
removePrefixLength
in interface AddressSegmentSeries
removePrefixLength
in interface IPAddressSegmentSeries
removePrefixLength
in class IPAddressSection
IPAddressSegmentSeries.removePrefixLength(boolean)
public IPv4AddressSection withoutPrefixLength()
AddressSegmentSeries
withoutPrefixLength
in interface AddressSection
withoutPrefixLength
in interface AddressSegmentSeries
withoutPrefixLength
in interface IPAddressSegmentSeries
withoutPrefixLength
in class IPAddressSection
public IPv4AddressSection removePrefixLength(boolean zeroed)
IPAddressSegmentSeries
IPAddressSegmentSeries.removePrefixLength()
removePrefixLength
in interface AddressSection
removePrefixLength
in interface AddressSegmentSeries
removePrefixLength
in interface IPAddressSegmentSeries
removePrefixLength
in class IPAddressSection
zeroed
- whether the host bits become zero.public IPv4AddressSection toZeroHost() throws IncompatibleAddressException
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 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
toZeroHost
in class IPAddressSection
IncompatibleAddressException
public IPv4AddressSection 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
toZeroHost
in class IPAddressSection
public IPv4AddressSection toMaxHost() throws IncompatibleAddressException
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
toMaxHost
in class IPAddressSection
IncompatibleAddressException
public IPv4AddressSection createMaxHost()
public IPv4AddressSection 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
toMaxHost
in class IPAddressSection
public IPv4AddressSection mask(IPv4AddressSection mask, boolean retainPrefix) throws IncompatibleAddressException, PrefixLenException, SizeMismatchException
mask
- retainPrefix
- whether to drop the prefixIncompatibleAddressException
PrefixLenException
SizeMismatchException
public IPv4AddressSection mask(IPv4AddressSection mask) throws IncompatibleAddressException
mask(IPv4AddressSection, boolean)
with the second argument as false.IncompatibleAddressException
public IPv4AddressSection maskNetwork(IPv4AddressSection mask, int networkPrefixLength) throws IncompatibleAddressException, PrefixLenException, SizeMismatchException
bitwiseOr(IPv4AddressSection)
or replace(int, IPv4AddressSection)
mask
- networkPrefixLength
- IncompatibleAddressException
PrefixLenException
SizeMismatchException
public IPv4AddressSection bitwiseOr(IPv4AddressSection mask) throws IncompatibleAddressException
bitwiseOr(IPv4AddressSection, boolean)
with the second argument as false.IncompatibleAddressException
public IPv4AddressSection bitwiseOr(IPv4AddressSection mask, boolean retainPrefix) throws IncompatibleAddressException, SizeMismatchException
mask(IPv4AddressSection)
which does the bitwise conjunction.retainPrefix
- whether the result will retain the same prefix length as this.IncompatibleAddressException
SizeMismatchException
public IPv4AddressSection bitwiseOrNetwork(IPv4AddressSection mask, int networkPrefixLength) throws IncompatibleAddressException, SizeMismatchException
maskNetwork(IPv4AddressSection, int)
which does the bitwise conjunction.
Any existing prefix length is dropped for the new prefix length and the disjunction is applied up to the end the new prefix length.
mask
- IncompatibleAddressException
SizeMismatchException
public IPv4AddressSection getNetworkSection()
IPAddressSegmentSeries
getNetworkSection
in interface IPAddressSegmentSeries
public IPv4AddressSection getNetworkSection(int networkPrefixLength) throws PrefixLenException
IPAddressSegmentSeries
getNetworkSection
in interface IPAddressSegmentSeries
PrefixLenException
public IPv4AddressSection getNetworkSection(int networkPrefixLength, boolean withPrefixLength) throws PrefixLenException
IPAddressSegmentSeries
getNetworkSection
in interface IPAddressSegmentSeries
withPrefixLength
- whether the resulting section will have networkPrefixLength as the associated prefix length or notPrefixLenException
public IPv4AddressSection getHostSection()
IPAddressSegmentSeries
getHostSection
in interface IPAddressSegmentSeries
public IPv4AddressSection getHostSection(int networkPrefixLength) throws PrefixLenException
IPAddressSegmentSeries
getHostSection
in interface IPAddressSegmentSeries
PrefixLenException
public IPv4AddressSection toPrefixBlock()
IPAddressSegmentSeries
toPrefixBlock
in interface AddressSection
toPrefixBlock
in interface AddressSegmentSeries
toPrefixBlock
in interface IPAddressSegmentSeries
toPrefixBlock
in class IPAddressSection
public IPv4AddressSection toPrefixBlock(int networkPrefixLength) throws PrefixLenException
IPAddressSegmentSeries
toPrefixBlock
in interface IPAddressSegmentSeries
toPrefixBlock
in class IPAddressSection
PrefixLenException
public IPv4AddressSection assignPrefixForSingleBlock()
IPAddressSection
If no such prefix length exists, returns null.
If this address represents just a single address, "this" is returned.
assignPrefixForSingleBlock
in interface IPAddressSegmentSeries
assignPrefixForSingleBlock
in class IPAddressSection
IPAddressSegmentSeries.toPrefixBlock()
,
IPAddressSegmentSeries.assignMinPrefixForBlock()
public IPv4AddressSection assignMinPrefixForBlock()
IPAddressSection
assignMinPrefixForBlock
in interface IPAddressSegmentSeries
assignMinPrefixForBlock
in class IPAddressSection
IPAddressSegmentSeries.toPrefixBlock()
,
IPAddressSegmentSeries.assignPrefixForSingleBlock()
public IPv4AddressSection[] spanWithPrefixBlocks(IPv4AddressSection other)
other
- public IPv4AddressSection[] spanWithRangedSegments(IPv4AddressSection other)
other
- public IPv4AddressSection[] mergePrefixBlocks(IPv4AddressSection... sections) throws SizeMismatchException
sections
- the sections to merge with thisSizeMismatchException
public IPv4AddressSection[] mergeToSequentialBlocks(IPv4AddressSection... sections) throws SizeMismatchException
sections
- the sections to merge with thisSizeMismatchException
public java.lang.String toCanonicalString()
toCanonicalString
in interface AddressSegmentSeries
public java.lang.String toFullString()
toFullString
in interface IPAddressSegmentSeries
public java.lang.String toCompressedString()
toCompressedString
in interface AddressSegmentSeries
public java.lang.String toNormalizedString()
toCanonicalString()
.toNormalizedString
in interface AddressComponent
public java.lang.String toCompressedWildcardString()
IPAddressSegmentSeries
toCompressedWildcardString
in interface IPAddressSegmentSeries
public java.lang.String toSubnetString()
IPAddressSegmentSeries
toSubnetString
in interface IPAddressSegmentSeries
public java.lang.String toPrefixLengthString()
IPAddressSegmentSeries
toPrefixLengthString
in interface IPAddressSegmentSeries
public java.lang.String toInetAtonString(IPv4Address.inet_aton_radix radix)
public java.lang.String toInetAtonString(IPv4Address.inet_aton_radix radix, int joinedCount)
public java.lang.String toNormalizedWildcardString()
IPAddressSegmentSeries
toNormalizedWildcardString
in interface IPAddressSegmentSeries
public java.lang.String toCanonicalWildcardString()
IPAddressSegmentSeries
toCanonicalWildcardString
in interface IPAddressSegmentSeries
public java.lang.String toSQLWildcardString()
IPAddressSegmentSeries
Address.SEGMENT_SQL_WILDCARD
instead of Address.SEGMENT_WILDCARD
and also uses Address.SEGMENT_SQL_SINGLE_WILDCARD
toSQLWildcardString
in interface IPAddressSegmentSeries
public java.lang.String toReverseDNSLookupString()
IPAddressSegmentSeries
toReverseDNSLookupString
in interface IPAddressSegmentSeries
public java.lang.String toNormalizedString(IPAddressSection.IPStringOptions stringParams, int joinCount)
public inet.ipaddr.format.standard.IPAddressDivisionGrouping toJoinedSegments(int joinCount)
public IPAddressPartStringCollection toAllStringCollection()
IPAddressSection
toAllStringCollection
in class IPAddressSection
public IPAddressPartStringCollection toStandardStringCollection()
IPAddressSection
toStandardStringCollection
in class IPAddressSection
public IPAddressPartStringCollection toDatabaseSearchStringCollection()
IPAddressSection
toDatabaseSearchStringCollection
in class IPAddressSection
public IPAddressPartStringCollection toStringCollection(IPAddressSection.IPStringBuilderOptions opts)
toStringCollection
in interface IPAddressSegmentSeries
public IPAddressPartStringCollection toStringCollection(IPv4AddressSection.IPv4StringBuilderOptions opts)
public inet.ipaddr.format.string.IPAddressStringDivisionSeries[] getParts(IPAddressSection.IPStringBuilderOptions options)
IPAddressSection
IPAddressDivisionGrouping
getParts
in class IPAddressSection
public inet.ipaddr.format.string.IPAddressStringDivisionSeries[] getParts(IPv4AddressSection.IPv4StringBuilderOptions options)