Class IPv4AddressSection

java.lang.Object

inet.ipaddr.format.AddressDivisionGroupingBase

inet.ipaddr.format.standard.AddressDivisionGrouping

inet.ipaddr.format.standard.IPAddressDivisionGrouping

inet.ipaddr.IPAddressSection

inet.ipaddr.ipv4.IPv4AddressSection

All Implemented Interfaces:

AddressComponent, AddressSection, AddressSegmentSeries, AddressComponentRange, AddressDivisionSeries, AddressItem, AddressItemRange, IPAddressDivisionSeries, AddressStringDivisionSeries, IPAddressStringDivisionSeries, IPAddressSegmentSeries, Serializable, Comparable<AddressItem>, Iterable<IPv4AddressSection>

public class IPv4AddressSection
extends IPAddressSection
implements Iterable<IPv4AddressSection>

A section of an IPv4Address. It is a series of 0 to 4 individual IPv4 address segments.

Author:

sfoley

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IPv4AddressSection.IPv4StringBuilderOptions
static class	IPv4AddressSection.IPv4StringOptions	Represents a clear way to create a specific type of string.

Nested classes/interfaces inherited from class IPAddressSection

IPAddressSection.IPStringBuilderOptions, IPAddressSection.IPStringOptions, IPAddressSection.SegFunction<R,S>, IPAddressSection.SeriesCreator, IPAddressSection.TriFunction<R,S>, IPAddressSection.WildcardOptions

Nested classes/interfaces inherited from class IPAddressDivisionGrouping

IPAddressDivisionGrouping.Range, IPAddressDivisionGrouping.RangeList

Nested classes/interfaces inherited from class AddressDivisionGrouping

AddressDivisionGrouping.DivisionLengthProvider, AddressDivisionGrouping.DivisionValueProvider, AddressDivisionGrouping.StringOptions

Constructor Summary

Constructors

Constructor	Description
IPv4AddressSection(byte[] bytes)
IPv4AddressSection(byte[] bytes, int byteStartIndex, int byteEndIndex)
IPv4AddressSection(byte[] bytes, int byteStartIndex, int byteEndIndex, Integer prefix)
IPv4AddressSection(byte[] bytes, Integer prefix)
IPv4AddressSection(int value)
IPv4AddressSection(int value, Integer networkPrefixLength)
IPv4AddressSection(Address.SegmentValueProvider valueProvider, int segmentCount)
IPv4AddressSection(Address.SegmentValueProvider valueProvider, int segmentCount, Integer networkPrefixLength)
IPv4AddressSection(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, int segmentCount)
IPv4AddressSection(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, int segmentCount, Integer networkPrefixLength)
IPv4AddressSection(IPv4AddressSegment segment)	Constructs a single segment section.
IPv4AddressSection(IPv4AddressSegment[] segments)
IPv4AddressSection(IPv4AddressSegment[] segments, Integer networkPrefixLength)

Method Summary

Modifier and Type	Method	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)	Deprecated.
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.
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.
AddressComponentSpliterator<IPv4AddressSection>	blockSpliterator(int segmentCount)	Partitions and traverses through the individual sequential blocks created from each of the individual values up to the given segment count.
Stream<IPv4AddressSection>	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(AddressSection other)	Determines if one section contains another.
IPv4AddressSection	coverWithPrefixBlock()	Returns the minimal-size prefix block that covers all the values in this series.
IPv4AddressSection	coverWithPrefixBlock(IPv4AddressSection other)
IPv4AddressSection	createMaxHost()
BigInteger	enumerate(AddressSection other)	Indicates where an address section sits relative to the ordering of individual address sections within this section.
Long	enumerateIPv4(IPv4AddressSection other)	Indicates where an address section sits relative to the ordering of individual address sections within this section.
boolean	equals(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()	Provides the number of bits comprising this address item
int	getBitsPerSegment()	Returns the number of bits comprising each segment in this series.
int	getByteCount()	Provides the number of bytes required for this address item, rounding up if the bit count is not a multiple of 8
int	getBytesPerSegment()	Returns the number of bytes comprising each segment in this series.
IPv4AddressSegment	getDivision(int index)
IPv4AddressSection	getHostMask()	Returns the host mask associated with the CIDR network prefix length of this series.
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
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 components of the same version (eg IPv4, IPv6 and MAC each have their own network object)
IPv4AddressSection	getNetworkMask()	Returns the network mask associated with the CIDR network prefix length of this series.
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.
IPAddressStringDivisionSeries[]	getParts(IPAddressSection.IPStringBuilderOptions options)	Get all representations of this address including this IPAddressSection.
IPAddressStringDivisionSeries[]	getParts(IPv4AddressSection.IPv4StringBuilderOptions options)
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 The first segment is at index 0.
IPv4AddressSection	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.
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(int start, int end, Collection<? super IPv4AddressSegment> segs)
void	getSegments(Collection<? super IPv4AddressSegment> segs)
IPv4AddressSection	getUpper()	If this represents a series with ranging values, returns a series representing the upper values of the range.
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 individual sections are found in both this and the given argument.
int	intValue()
boolean	isIPv4()
Iterator<IPv4AddressSection>	iterator()	Iterates through the individual address components.
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)	Deprecated. use mergeToPrefixBlocks(IPv4AddressSection...)
IPv4AddressSection[]	mergeToPrefixBlocks(IPv4AddressSection... sections)	Merges this with the list of sections to produce the smallest array of prefix blocks.
IPv4AddressSection[]	mergeToSequentialBlocks(IPv4AddressSection... sections)	Merges this with the list of sections to produce the smallest array of sequential block subnets.
Iterator<IPv4AddressSection>	nonZeroHostIterator()	Similar to the iterator, but series with a host of zero are skipped.
boolean	overlaps(AddressSection other)	Determines if one section overlaps another.
Iterator<IPv4AddressSection>	prefixBlockIterator()	Iterates through the individual prefix blocks.
AddressComponentSpliterator<IPv4AddressSection>	prefixBlockSpliterator()	Partitions and traverses through the individual prefix blocks for the prefix length of this series.
Stream<IPv4AddressSection>	prefixBlockStream()	Returns a sequential stream of the individual prefix blocks for the prefix length of this series.
boolean	prefixContains(IPAddressSection other)	Returns whether the prefix of this address contains all values of the same bits in the given address or subnet
boolean	prefixEquals(AddressSection other)	Determines if the argument section matches this section up to the prefix length of this section.
Iterator<IPv4AddressSection>	prefixIterator()	Iterates through the individual prefixes.
AddressComponentSpliterator<IPv4AddressSection>	prefixSpliterator()	Partitions and traverses through the individual prefixes for the prefix length of this series.
Stream<IPv4AddressSection>	prefixStream()	Returns a sequential stream of the individual prefixes for the prefix length of this series.
IPv4AddressSection	removePrefixLength()	Deprecated.
IPv4AddressSection	removePrefixLength(boolean zeroed)	Deprecated.
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.
Iterator<IPv4AddressSegment[]>	segmentsIterator()	Iterates through the individual segments.
Iterator<IPv4AddressSegment[]>	segmentsNonZeroHostIterator()	Similar to the segments iterator, but series with a host of zero are skipped.
AddressComponentRangeSpliterator<IPv4AddressSection, IPv4AddressSegment[]>	segmentsSpliterator()	Partitions and traverses through the individual segment arrays.
Stream<IPv4AddressSegment[]>	segmentsStream()	Returns a sequential stream of the individual segment arrays.
Iterator<IPv4AddressSection>	sequentialBlockIterator()	Iterates through the sequential series that make up this series.
AddressComponentSpliterator<IPv4AddressSection>	sequentialBlockSpliterator()	Partitions and traverses through the individual sequential blocks.
Stream<IPv4AddressSection>	sequentialBlockStream()	Returns a sequential stream of the individual sequential blocks.
IPv4AddressSection	setPrefixLength(int networkPrefixLength)	Sets the prefix length.
IPv4AddressSection	setPrefixLength(int networkPrefixLength, boolean withZeros)	Sets the prefix length.
IPv4AddressSection	setPrefixLength(int networkPrefixLength, boolean withZeros, 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.
IPv4AddressSection[]	spanWithPrefixBlocks()	Produces an array of prefix blocks that spans the same set of values.
IPv4AddressSection[]	spanWithPrefixBlocks(IPv4AddressSection other)	Produces the list of prefix block subnets that span from this series to the given series.
IPv4AddressSection[]	spanWithRangedSegments(IPv4AddressSection other)	Deprecated. use spanWithSequentialBlocks(IPv4AddressSection)
IPv4AddressSection[]	spanWithSequentialBlocks()	Produces an array of blocks that are sequential that cover the same set of sections as this.
IPv4AddressSection[]	spanWithSequentialBlocks(IPv4AddressSection other)	Produces a list of range subnets that span from this series to the given series.
AddressComponentSpliterator<IPv4AddressSection>	spliterator()	Partitions and traverses through the individual address components.
Stream<IPv4AddressSection>	stream()	Returns a sequential stream of the individual address components.
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...
String	toCanonicalString()	This produces a canonical string.
String	toCanonicalWildcardString()	This produces a string similar to the canonical string and avoids the CIDR prefix.
String	toCompressedString()	The shortest string for IPv4 addresses is the same as the canonical string.
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
String	toFullString()	This produces a string with no compressed segments and all segments of full length, which is 3 characters for IPv4 segments.
String	toInetAtonString(IPv4Address.inet_aton_radix radix)
String	toInetAtonString(IPv4Address.inet_aton_radix radix, int joinedCount)
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.
String	toNormalizedString()	The normalized string returned by this method is consistent with java.net.Inet4Address, and is the same as toCanonicalString().
String	toNormalizedString(IPAddressSection.IPStringOptions stringParams, int joinCount)
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.
String	toPrefixLengthString()	Returns a string with a CIDR prefix length if this section has a network prefix length.
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
String	toSegmentedBinaryString()	Writes this IP address segment series as a segments of binary values preceded by the "0b" prefix.
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)
String	toSubnetString()	Produces a consistent subnet string.
IPv4AddressSection	toZeroHost()	Returns the segment series with a host of zero, the host being the bits following the prefix length.
IPv4AddressSection	toZeroHost(int prefixLength)	Produces the series with host values of 0 for the given prefix length.
IPv4AddressSection	toZeroNetwork()	Returns the segment series with a network of zero, the network being the bits within the prefix length.
int	upperIntValue()
long	upperLongValue()
IPv4AddressSection	withoutPrefixLength()	Provides the same address with no prefix.

Methods inherited from class IPAddressSection

bitsPerSegment, bytesPerSegment, containsNonZeroHosts, containsPrefixBlock, getBlockCount, getBlockMaskPrefixLength, getCountImpl, getMaxSegmentValue, getMinPrefixLengthForBlock, getNonZeroHostCount, getPrefixLengthForSingleBlock, getSegmentCount, getSegments, getSegments, getSegmentStrings, getSequentialBlockCount, getStartsWithSQLClause, getStartsWithSQLClause, includesMaxHost, includesMaxHost, includesZeroHost, includesZeroHost, isEntireAddress, isFullRange, isIPv6, isSingleNetwork, isSinglePrefixBlock, isZeroHost, isZeroHost, toBinaryString, toHexString, toNormalizedString, toNormalizedString, toOctalString, toString

Methods inherited from class IPAddressDivisionGrouping

containsSinglePrefixBlock, getLeadingBitCount, getNetworkPrefixLength, getPrefixLength, getTrailingBitCount, getZeroRangeSegments, getZeroSegments, isMore, isPrefixBlock

Methods inherited from class AddressDivisionGrouping

hashCode

Methods inherited from class AddressDivisionGroupingBase

getBytes, getBytes, getBytes, getCount, getDivisionCount, getDivisionStrings, getPrefixCount, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isMax, isMultiple, isPrefixed, isSequential, isZero

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AddressDivisionSeries

getCount, getDivisionStrings, getPrefixCount, getPrefixLength, getSequentialBlockIndex, isMore, isPrefixBlock, isPrefixed, isSequential

Methods inherited from interface AddressItem

compareTo, containsSinglePrefixBlock, getBytes, getBytes, getBytes, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isMax, isMultiple, isZero

Methods inherited from interface AddressSegmentSeries

isOneBit, testBit

Methods inherited from interface AddressStringDivisionSeries

getDivisionCount

Methods inherited from interface IPAddressDivisionSeries

getNetworkPrefixLength

Methods inherited from interface IPAddressStringDivisionSeries

getPrefixLength, isPrefixBlock, isPrefixed

Methods inherited from interface Iterable

forEach

Constructor Details

IPv4AddressSection

public IPv4AddressSection(IPv4AddressSegment segment)

Constructs a single segment section.

Parameters:

segment -

IPv4AddressSection

public IPv4AddressSection(IPv4AddressSegment[] segments)
                   throws AddressValueException

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(IPv4AddressSegment[] segments,
 Integer networkPrefixLength)
                   throws AddressValueException

Parameters:

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 -

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(Address.SegmentValueProvider valueProvider,
 int segmentCount,
 Integer networkPrefixLength)
                   throws AddressValueException

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(Address.SegmentValueProvider lowerValueProvider,
 Address.SegmentValueProvider upperValueProvider,
 int segmentCount,
 Integer networkPrefixLength)
                   throws AddressValueException

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(Address.SegmentValueProvider valueProvider,
 int segmentCount)
                   throws AddressValueException

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(Address.SegmentValueProvider lowerValueProvider,
 Address.SegmentValueProvider upperValueProvider,
 int segmentCount)

IPv4AddressSection

public IPv4AddressSection(byte[] bytes,
 Integer prefix)
                   throws AddressValueException

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(byte[] bytes)
                   throws AddressValueException

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(byte[] bytes,
 int byteStartIndex,
 int byteEndIndex,
 Integer prefix)
                   throws AddressValueException

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(byte[] bytes,
 int byteStartIndex,
 int byteEndIndex)
                   throws AddressValueException

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(int value,
 Integer networkPrefixLength)
                   throws AddressValueException

Throws:

AddressValueException

IPv4AddressSection

public IPv4AddressSection(int value)

Method Details

getSegments

public IPv4AddressSegment[] getSegments()

Description copied from interface: AddressSegmentSeries

Returns the segments of this series of segments as an array. This must create a new array, so for efficiency use AddressSegmentSeries.getSegment(int) and AddressSegmentSeries.getSegmentCount() instead when feasible.

Specified by:

getSegments in interface AddressSegmentSeries

Specified by:

getSegments in interface IPAddressSegmentSeries

Returns:

getSection

public IPv4AddressSection getSection()

Description copied from interface: AddressSegmentSeries

Gets the subsection from the series that comprises all segments

Specified by:

getSection in interface AddressSegmentSeries

Specified by:

getSection in interface IPAddressSegmentSeries

Returns:

getSection

public IPv4AddressSection getSection(int index)

Description copied from interface: AddressSegmentSeries

Gets the subsection from the series starting from the given index The first segment is at index 0.

Specified by:

getSection in interface AddressSegmentSeries

Specified by:

getSection in interface IPAddressSegmentSeries

Specified by:

getSection in class IPAddressSection

Parameters:

index -

Returns:

getSection

public IPv4AddressSection getSection(int index,
 int endIndex)

Description copied from interface: AddressSegmentSeries

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.

Specified by:

getSection in interface AddressSegmentSeries

Specified by:

getSection in interface IPAddressSegmentSeries

Specified by:

getSection in class IPAddressSection

Parameters:

index -

endIndex -

Returns:

getLowerNonZeroHost

public IPv4AddressSection getLowerNonZeroHost()

Description copied from interface: IPAddressSegmentSeries

Similar to 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().

Specified by:

getLowerNonZeroHost in interface IPAddressSegmentSeries

Specified by:

getLowerNonZeroHost in class IPAddressSection

Returns:

the lowest IP address series whose host is non-zero, or null if no such address section exists.

getLower

public IPv4AddressSection getLower()

Description copied from interface: AddressSegmentSeries

If this represents a series with ranging values, returns a series representing the lower values of the range. If this represents an series with a single value in each segment, returns this.

Specified by:

getLower in interface AddressComponentRange

Specified by:

getLower in interface AddressSection

Specified by:

getLower in interface AddressSegmentSeries

Specified by:

getLower in interface IPAddressSegmentSeries

Specified by:

getLower in class IPAddressSection

Returns:

getUpper

public IPv4AddressSection getUpper()

Description copied from interface: AddressSegmentSeries

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.

Specified by:

getUpper in interface AddressComponentRange

Specified by:

getUpper in interface AddressSection

Specified by:

getUpper in interface AddressSegmentSeries

Specified by:

getUpper in interface IPAddressSegmentSeries

Specified by:

getUpper in class IPAddressSection

Returns:

intValue

public int intValue()

upperIntValue

public int upperIntValue()

longValue

public long longValue()

upperLongValue

public long upperLongValue()

reverseBits

public IPv4AddressSection reverseBits(boolean perByte)

Description copied from interface: IPAddressSegmentSeries

Returns a new series which has the bits reversed.

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.

Specified by:

reverseBits in interface AddressComponent

Specified by:

reverseBits in interface AddressSection

Specified by:

reverseBits in interface AddressSegmentSeries

Specified by:

reverseBits in interface IPAddressSegmentSeries

Specified by:

reverseBits in class IPAddressSection

Parameters:

perByte - if true, only the bits in each byte are reversed, if false, then all bits in the address are reversed

Returns:

reverseBytes

public IPv4AddressSection reverseBytes()

Description copied from interface: AddressSegmentSeries

Returns a new segment series with the bytes reversed.

Specified by:

reverseBytes in interface AddressComponent

Specified by:

reverseBytes in interface AddressSection

Specified by:

reverseBytes in interface AddressSegmentSeries

Specified by:

reverseBytes in interface IPAddressSegmentSeries

Specified by:

reverseBytes in class IPAddressSection

Returns:

reverseBytesPerSegment

public IPv4AddressSection reverseBytesPerSegment()

Description copied from interface: AddressSegmentSeries

Returns a new segment series with the bytes reversed within each segment.

Specified by:

reverseBytesPerSegment in interface AddressSection

Specified by:

reverseBytesPerSegment in interface AddressSegmentSeries

Specified by:

reverseBytesPerSegment in interface IPAddressSegmentSeries

Specified by:

reverseBytesPerSegment in class IPAddressSection

Returns:

reverseSegments

public IPv4AddressSection reverseSegments()

Description copied from interface: AddressSegmentSeries

Returns a new segment series with the segments reversed. This does not throw IncompatibleAddressException since all address series can reverse their segments.

Specified by:

reverseSegments in interface AddressSection

Specified by:

reverseSegments in interface AddressSegmentSeries

Specified by:

reverseSegments in interface IPAddressSegmentSeries

Specified by:

reverseSegments in class IPAddressSection

Returns:

getIterable

public Iterable<IPv4AddressSection> getIterable()

Description copied from interface: AddressComponentRange

Useful for using an instance in a "for-each loop". Otherwise just call AddressComponentRange.iterator() directly.

Specified by:

getIterable in interface AddressComponentRange

Specified by:

getIterable in interface AddressSection

Specified by:

getIterable in interface AddressSegmentSeries

Specified by:

getIterable in interface IPAddressSegmentSeries

Specified by:

getIterable in class IPAddressSection

Returns:

nonZeroHostIterator

public Iterator<IPv4AddressSection> nonZeroHostIterator()

Description copied from interface: IPAddressSegmentSeries

Similar to the iterator, but series with a host of zero are skipped.

Specified by:

nonZeroHostIterator in interface IPAddressSegmentSeries

Specified by:

nonZeroHostIterator in class IPAddressSection

Returns:

iterator

public Iterator<IPv4AddressSection> iterator()

Description copied from interface: AddressComponentRange

Iterates through the individual address components.

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.

Specified by:

iterator in interface AddressComponentRange

Specified by:

iterator in interface AddressSection

Specified by:

iterator in interface AddressSegmentSeries

Specified by:

iterator in interface IPAddressSegmentSeries

Specified by:

iterator in interface Iterable<IPv4AddressSection>

Specified by:

iterator in class IPAddressSection

Returns:

spliterator

public AddressComponentSpliterator<IPv4AddressSection> spliterator()

Description copied from interface: AddressComponentRange

Partitions and traverses through the individual address components.

Specified by:

spliterator in interface AddressComponent

Specified by:

spliterator in interface AddressComponentRange

Specified by:

spliterator in interface AddressSection

Specified by:

spliterator in interface AddressSegmentSeries

Specified by:

spliterator in interface IPAddressSegmentSeries

Specified by:

spliterator in interface Iterable<IPv4AddressSection>

Specified by:

spliterator in class IPAddressSection

Returns:

stream

public Stream<IPv4AddressSection> stream()

Description copied from interface: AddressComponentRange

Returns a sequential stream of the individual address components. For a parallel stream, call BaseStream.parallel() on the returned stream.

Specified by:

stream in interface AddressComponentRange

Specified by:

stream in interface AddressSection

Specified by:

stream in interface AddressSegmentSeries

Specified by:

stream in interface IPAddressSegmentSeries

Specified by:

stream in class IPAddressSection

Returns:

prefixIterator

public Iterator<IPv4AddressSection> prefixIterator()

Description copied from interface: AddressSegmentSeries

Iterates through the individual prefixes.

If the series has no prefix length, then this is equivalent to AddressSegmentSeries.iterator()

Specified by:

prefixIterator in interface AddressSection

Specified by:

prefixIterator in interface AddressSegmentSeries

Specified by:

prefixIterator in interface IPAddressSegmentSeries

Specified by:

prefixIterator in class IPAddressSection

prefixSpliterator

public AddressComponentSpliterator<IPv4AddressSection> prefixSpliterator()

Description copied from interface: AddressSegmentSeries

Partitions and traverses through the individual prefixes for the prefix length of this series.

Specified by:

prefixSpliterator in interface AddressSection

Specified by:

prefixSpliterator in interface AddressSegmentSeries

Specified by:

prefixSpliterator in interface IPAddressSegmentSeries

Specified by:

prefixSpliterator in class IPAddressSection

Returns:

prefixStream

public Stream<IPv4AddressSection> prefixStream()

Description copied from interface: AddressSegmentSeries

Returns a sequential stream of the individual prefixes for the prefix length of this series. For a parallel stream, call BaseStream.parallel() on the returned stream.

Specified by:

prefixStream in interface AddressSection

Specified by:

prefixStream in interface AddressSegmentSeries

Specified by:

prefixStream in interface IPAddressSegmentSeries

Specified by:

prefixStream in class IPAddressSection

Returns:

prefixBlockIterator

public Iterator<IPv4AddressSection> prefixBlockIterator()

Description copied from interface: AddressSegmentSeries

Iterates through the individual prefix blocks.

If the series has no prefix length, then this is equivalent to AddressSegmentSeries.iterator()

Specified by:

prefixBlockIterator in interface AddressSection

Specified by:

prefixBlockIterator in interface AddressSegmentSeries

Specified by:

prefixBlockIterator in interface IPAddressSegmentSeries

Specified by:

prefixBlockIterator in class IPAddressSection

prefixBlockSpliterator

public AddressComponentSpliterator<IPv4AddressSection> prefixBlockSpliterator()

Description copied from interface: AddressSegmentSeries

Partitions and traverses through the individual prefix blocks for the prefix length of this series.

Specified by:

prefixBlockSpliterator in interface AddressSection

Specified by:

prefixBlockSpliterator in interface AddressSegmentSeries

Specified by:

prefixBlockSpliterator in interface IPAddressSegmentSeries

Specified by:

prefixBlockSpliterator in class IPAddressSection

Returns:

prefixBlockStream

public Stream<IPv4AddressSection> prefixBlockStream()

Description copied from interface: AddressSegmentSeries

Returns a sequential stream of the individual prefix blocks for the prefix length of this series. For a parallel stream, call BaseStream.parallel() on the returned stream.

Specified by:

prefixBlockStream in interface AddressSection

Specified by:

prefixBlockStream in interface AddressSegmentSeries

Specified by:

prefixBlockStream in interface IPAddressSegmentSeries

Specified by:

prefixBlockStream in class IPAddressSection

Returns:

blockIterator

public Iterator<IPv4AddressSection> blockIterator(int segmentCount)

Description copied from interface: IPAddressSegmentSeries

Iterates through series that can be obtained by iterating through all the upper segments up to the given segment count. Segments following remain the same in all iterated series.

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

Specified by:

blockIterator in interface IPAddressSegmentSeries

Specified by:

blockIterator in class IPAddressSection

Parameters:

segmentCount -

Returns:

blockSpliterator

public AddressComponentSpliterator<IPv4AddressSection> blockSpliterator(int segmentCount)

Description copied from interface: IPAddressSegmentSeries

Partitions and traverses through the individual sequential blocks created from each of the individual values up to the given segment count.

Specified by:

blockSpliterator in interface IPAddressSegmentSeries

Specified by:

blockSpliterator in class IPAddressSection

Returns:

blockStream

public Stream<IPv4AddressSection> blockStream(int segmentCount)

Description copied from interface: IPAddressSegmentSeries

Returns a sequential stream of the individual blocks created from each of the individual values up to the given segment count. For a parallel stream, call BaseStream.parallel() on the returned stream.

Specified by:

blockStream in interface IPAddressSegmentSeries

Specified by:

blockStream in class IPAddressSection

Returns:

sequentialBlockIterator

public Iterator<IPv4AddressSection> sequentialBlockIterator()

Description copied from interface: IPAddressSegmentSeries

Iterates through the sequential series that make up this series. Generally this means finding the count of segments for which the segments that follow are not full range, and then using 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.

Specified by:

sequentialBlockIterator in interface IPAddressSegmentSeries

Overrides:

sequentialBlockIterator in class IPAddressSection

Returns:

sequentialBlockSpliterator

public AddressComponentSpliterator<IPv4AddressSection> sequentialBlockSpliterator()

Description copied from interface: IPAddressSegmentSeries

Partitions and traverses through the individual sequential blocks.

Specified by:

sequentialBlockSpliterator in interface IPAddressSegmentSeries

Overrides:

sequentialBlockSpliterator in class IPAddressSection

Returns:

sequentialBlockStream

public Stream<IPv4AddressSection> sequentialBlockStream()

Description copied from interface: IPAddressSegmentSeries

Returns a sequential stream of the individual sequential blocks. For a parallel stream, call BaseStream.parallel() on the returned stream.

Use IPAddressSegmentSeries.getSequentialBlockCount() to get the count of streamed elements.

Specified by:

sequentialBlockStream in interface IPAddressSegmentSeries

Overrides:

sequentialBlockStream in class IPAddressSection

Returns:

segmentsNonZeroHostIterator

public Iterator<IPv4AddressSegment[]> segmentsNonZeroHostIterator()

Description copied from interface: IPAddressSegmentSeries

Similar to the segments iterator, but series with a host of zero are skipped.

Specified by:

segmentsNonZeroHostIterator in interface IPAddressSegmentSeries

Returns:

segmentsIterator

public Iterator<IPv4AddressSegment[]> segmentsIterator()

Description copied from interface: AddressSegmentSeries

Iterates through the individual segments.

Specified by:

segmentsIterator in interface AddressSegmentSeries

Specified by:

segmentsIterator in interface IPAddressSegmentSeries

segmentsSpliterator

public AddressComponentRangeSpliterator<IPv4AddressSection, IPv4AddressSegment[]> segmentsSpliterator()

Description copied from interface: AddressSegmentSeries

Partitions and traverses through the individual segment arrays.

Specified by:

segmentsSpliterator in interface AddressSegmentSeries

Specified by:

segmentsSpliterator in interface IPAddressSegmentSeries

Returns:

segmentsStream

public Stream<IPv4AddressSegment[]> segmentsStream()

Description copied from interface: AddressSegmentSeries

Returns a sequential stream of the individual segment arrays. For a parallel stream, call BaseStream.parallel() on the returned stream.

Specified by:

segmentsStream in interface AddressSegmentSeries

Specified by:

segmentsStream in interface IPAddressSegmentSeries

Returns:

incrementBoundary

public IPv4AddressSection incrementBoundary(long increment)

Description copied from interface: AddressSegmentSeries

If the given increment is positive, adds the value to the upper series (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.

Specified by:

incrementBoundary in interface AddressSection

Specified by:

incrementBoundary in interface AddressSegmentSeries

Specified by:

incrementBoundary in interface IPAddressSegmentSeries

Specified by:

incrementBoundary in class IPAddressSection

Parameters:

increment -

Returns:

increment

public IPv4AddressSection increment(long increment)

Description copied from interface: AddressSegmentSeries

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.

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.

Specified by:

increment in interface AddressSection

Specified by:

increment in interface AddressSegmentSeries

Specified by:

increment in interface IPAddressSegmentSeries

Specified by:

increment in class IPAddressSection

Parameters:

increment -

Returns:

getIPv4Count

public long getIPv4Count(boolean excludeZeroHosts)

getIPv4PrefixCount

public long getIPv4PrefixCount(int prefixLength)

getPrefixCount

public BigInteger getPrefixCount(int prefixLength)

Description copied from interface: AddressItem

The count of the number of distinct values within the prefix part of the address item, the bits that appear within the prefix length.

Specified by:

getPrefixCount in interface AddressDivisionSeries

Specified by:

getPrefixCount in interface AddressItem

Parameters:

prefixLength -

Returns:

getIPv4PrefixCount

public long getIPv4PrefixCount()

getDivision

public IPv4AddressSegment getDivision(int index)

Specified by:

getDivision in interface AddressDivisionSeries

Specified by:

getDivision in interface AddressStringDivisionSeries

Specified by:

getDivision in interface IPAddressDivisionSeries

Specified by:

getDivision in interface IPAddressStringDivisionSeries

Overrides:

getDivision in class IPAddressSection

Returns:

the given division in this series. The first is at index 0.

getSegment

public IPv4AddressSegment getSegment(int index)

Description copied from interface: AddressSegmentSeries

Returns the segment from this series at the given index. The first segment is at index 0. A segment is an address division, see AddressDivisionSeries.getDivision(int), the difference being that all segments in a given series are the same bit count, while divisions can have variable length.

Specified by:

getSegment in interface AddressSegmentSeries

Specified by:

getSegment in interface IPAddressSegmentSeries

Overrides:

getSegment in class IPAddressSection

Returns:

getSegments

public void getSegments(Collection<? super IPv4AddressSegment> segs)

getSegments

public void getSegments(int start,
 int end,
 Collection<? super IPv4AddressSegment> segs)

getBitsPerSegment

public int getBitsPerSegment()

Description copied from interface: AddressSegmentSeries

Returns the number of bits comprising each segment in this series. Segments in the same series are equal length.

Specified by:

getBitsPerSegment in interface AddressSegmentSeries

Returns:

getBytesPerSegment

public int getBytesPerSegment()

Description copied from interface: AddressSegmentSeries

Returns the number of bytes comprising each segment in this series. Segments in the same series are equal length.

Specified by:

getBytesPerSegment in interface AddressSegmentSeries

Returns:

getBitCount

public int getBitCount()

Description copied from interface: AddressItem

Provides the number of bits comprising this address item

Specified by:

getBitCount in interface AddressDivisionSeries

Specified by:

getBitCount in interface AddressItem

Overrides:

getBitCount in class IPAddressSection

Returns:

the number of bits

getByteCount

public int getByteCount()

Description copied from interface: AddressItem

Provides the number of bytes required for this address item, rounding up if the bit count is not a multiple of 8

Specified by:

getByteCount in interface AddressItem

Overrides:

getByteCount in class IPAddressSection

Returns:

the number of bytes

isIPv4

public boolean isIPv4()

Overrides:

isIPv4 in class IPAddressSection

getIPVersion

public IPAddress.IPVersion getIPVersion()

Description copied from interface: IPAddressSegmentSeries

Returns the version of this segment series

Specified by:

getIPVersion in interface IPAddressSegmentSeries

Returns:

matchesWithMask

public boolean matchesWithMask(IPAddressSection other,
 IPAddressSection mask)

Description copied from class: IPAddressSection

Applies the mask to this address section and then compares values with the given address section

Overrides:

matchesWithMask in class IPAddressSection

Parameters:

other -

mask -

Returns:

equals

public boolean equals(Object o)

Description copied from class: AddressDivisionGroupingBase

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.

Overrides:

equals in class IPAddressDivisionGrouping

overlaps

public boolean overlaps(AddressSection other)

Description copied from interface: AddressSection

Determines if one section overlaps another.

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.

Specified by:

overlaps in interface AddressSection

Parameters:

other -

Returns:

whether this section overlaps the given address section

contains

public boolean contains(AddressSection other)

Description copied from interface: AddressSection

Determines if one section contains another.

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.

Specified by:

contains in interface AddressSection

Overrides:

contains in class IPAddressSection

Parameters:

other -

Returns:

whether this subnet contains the given address section

enumerateIPv4

public Long enumerateIPv4(IPv4AddressSection other)

Indicates where an address section sits relative to the ordering of individual address sections within this section.

Equivalent to enumerate(AddressSection) but returns a Long rather than a BigInteger.

enumerate

public BigInteger enumerate(AddressSection other)

Description copied from interface: AddressSection

Indicates where an address section sits relative to the ordering of individual address sections within this section.

Determines how many address section elements precede the given address section element, if the given address section is within this address section. If above the range, it is the distance to the upper boundary added to the address section count less one, and if below the range, the distance to the lower boundary.

In other words, if the given address section is not in this section but above it, returns the number of individual address sections preceding the given address section from the upper section boundary, added to one less than the total number of individual address sections within. If the given address section is not in this section but below it, returns the number of individual address sections following the given address section to the lower section boundary.

enumerate returns null when the argument is a multi-valued section. The argument must be an individual address section.

When this address section is also single-valued, the returned value is the distance (difference) between this address section and the argument address section.

enumerate is the inverse of the increment method:

• section.enumerate(section.increment(inc)) = inc
• section.increment(section.enumerate(individualSection)) = individualSection

If the given address section does not have the same version or type as this address section, then null is returned. If the given address section is the same version and type, but has a different segment count, then SizeMismatchException is thrown.

Specified by:

enumerate in interface AddressSection

prefixEquals

public boolean prefixEquals(AddressSection other)

Description copied from interface: AddressSection

Determines if the argument section matches this section up to the prefix length of this section.

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.

Specified by:

prefixEquals in interface AddressSection

Parameters:

other -

Returns:

whether the argument section has the same address section prefix as this

prefixContains

public boolean prefixContains(IPAddressSection other)

Description copied from class: IPAddressSection

Returns whether the prefix of this address contains all values of the same bits in the given address or subnet

Specified by:

prefixContains in class IPAddressSection

Parameters:

other -

Returns:

append

public IPv4AddressSection append(IPv4AddressSection other)

insert

public IPv4AddressSection insert(int index,
 IPv4AddressSection other)

replace

public IPv4AddressSection replace(int index,
 IPv4AddressSection other)

Replace the segments of this section starting at the given index with the given replacement segments

Parameters:

index -

other -

Returns:

appendToNetwork

public IPv4AddressSection appendToNetwork(IPv4AddressSection other)

replace

public 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

Parameters:

startIndex -

endIndex -

replacement -

replacementStartIndex -

replacementEndIndex -

Returns:

Throws:

IndexOutOfBoundsException

IncompatibleAddressException - if the resulting section would exceed the maximum segment count for this address type and version

intersect

public IPv4AddressSection intersect(IPv4AddressSection other)
                             throws SizeMismatchException

Produces the subnet sections whose individual sections are found in both this and the given argument.

This is also known as the conjunction of the two sets of address sections.

Parameters:

other -

Returns:

the section containing the sections found in both this and the given subnet sections

Throws:

SizeMismatchException

subtract

public IPv4AddressSection[] subtract(IPv4AddressSection other)
                              throws SizeMismatchException

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).

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.

Parameters:

other -

Returns:

the difference, or null if there are no remaining sections

Throws:

SizeMismatchException - if the two sections are different sizes

getNetwork

public IPv4AddressNetwork getNetwork()

Description copied from interface: AddressComponent

Returns the network object for components of the same version (eg IPv4, IPv6 and MAC each have their own network object)

Specified by:

getNetwork in interface AddressComponent

Specified by:

getNetwork in interface IPAddressSegmentSeries

Specified by:

getNetwork in interface IPAddressStringDivisionSeries

Overrides:

getNetwork in class IPAddressDivisionGrouping

Returns:

adjustPrefixBySegment

public IPv4AddressSection adjustPrefixBySegment(boolean nextSegment)

Description copied from interface: AddressSegmentSeries

Increases or decreases prefix length to the next segment boundary.

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.

Specified by:

adjustPrefixBySegment in interface AddressSection

Specified by:

adjustPrefixBySegment in interface AddressSegmentSeries

Specified by:

adjustPrefixBySegment in interface IPAddressSegmentSeries

Specified by:

adjustPrefixBySegment in class IPAddressSection

Parameters:

nextSegment - whether to move prefix to previous or following segment boundary

Returns:

adjustPrefixBySegment

public IPv4AddressSection adjustPrefixBySegment(boolean nextSegment,
 boolean zeroed)

Description copied from interface: AddressSegmentSeries

Increases or decreases prefix length to the next segment boundary.

Specified by:

adjustPrefixBySegment in interface AddressSection

Specified by:

adjustPrefixBySegment in interface AddressSegmentSeries

Specified by:

adjustPrefixBySegment in interface IPAddressSegmentSeries

Overrides:

adjustPrefixBySegment in class IPAddressSection

Parameters:

nextSegment - whether to move prefix to previous or following segment boundary

zeroed - whether the bits that move from one side of the prefix to the other become zero or retain their original values

Returns:

adjustPrefixLength

public IPv4AddressSection adjustPrefixLength(int adjustment)

Description copied from interface: AddressSegmentSeries

Increases or decreases prefix length by the given increment.

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. To avoid the zeroing behaviour, use AddressSegmentSeries.adjustPrefixLength(int, boolean) with second arg false.

Specified by:

adjustPrefixLength in interface AddressSection

Specified by:

adjustPrefixLength in interface AddressSegmentSeries

Specified by:

adjustPrefixLength in interface IPAddressSegmentSeries

Specified by:

adjustPrefixLength in class IPAddressSection

Parameters:

adjustment -

Returns:

adjustPrefixLength

public IPv4AddressSection adjustPrefixLength(int adjustment,
 boolean zeroed)

Description copied from interface: AddressSegmentSeries

Increases or decreases prefix length by the given increment.

Specified by:

adjustPrefixLength in interface AddressSection

Specified by:

adjustPrefixLength in interface AddressSegmentSeries

Specified by:

adjustPrefixLength in interface IPAddressSegmentSeries

Specified by:

adjustPrefixLength in class IPAddressSection

Parameters:

adjustment - the increment

zeroed - whether the bits that move from one side of the prefix to the other become zero or retain their original values

Returns:

applyPrefixLength

@Deprecated
public IPv4AddressSection applyPrefixLength(int networkPrefixLength)

Deprecated.

Description copied from interface: AddressSegmentSeries

Applies the given prefix length to create a new segment series.

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.

Specified by:

applyPrefixLength in interface AddressSection

Specified by:

applyPrefixLength in interface AddressSegmentSeries

Specified by:

applyPrefixLength in interface IPAddressSegmentSeries

Specified by:

applyPrefixLength in class IPAddressSection

Parameters:

networkPrefixLength -

Returns:

See Also:

• AddressSegmentSeries.setPrefixLength(int)

setPrefixLength

public IPv4AddressSection setPrefixLength(int networkPrefixLength)

Description copied from interface: AddressSegmentSeries

Sets the prefix length.

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.

Specified by:

setPrefixLength in interface AddressSection

Specified by:

setPrefixLength in interface AddressSegmentSeries

Specified by:

setPrefixLength in interface IPAddressSegmentSeries

Specified by:

setPrefixLength in class IPAddressSection

Parameters:

networkPrefixLength -

Returns:

setPrefixLength

public IPv4AddressSection setPrefixLength(int networkPrefixLength,
 boolean withZeros)

Description copied from interface: AddressSegmentSeries

Sets the prefix length.

When the prefix is extended beyond the segment series boundary, it is removed.

Specified by:

setPrefixLength in interface AddressSection

Specified by:

setPrefixLength in interface AddressSegmentSeries

Specified by:

setPrefixLength in interface IPAddressSegmentSeries

Specified by:

setPrefixLength in class IPAddressSection

Parameters:

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.

Returns:

setPrefixLength

public IPv4AddressSection setPrefixLength(int networkPrefixLength,
 boolean withZeros,
 boolean zeroHostIsBlock)
                                   throws PrefixLenException

Description copied from class: IPAddressSection

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. The latter behaviour only applies to the default prefix handling configuration, PREFIXED_ZERO_HOSTS_ARE_SUBNETS. The methods IPAddressSection.setPrefixLength(int, boolean) and IPAddressSection.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 prefix 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.

Specified by:

setPrefixLength in class IPAddressSection

Parameters:

networkPrefixLength -

withZeros -

zeroHostIsBlock -

Returns:

Throws:

PrefixLenException

removePrefixLength

@Deprecated
public IPv4AddressSection removePrefixLength()

Deprecated.

Description copied from interface: AddressSegmentSeries

Removes the prefix length while zeroing out the bits beyond the prefix.

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)

Specified by:

removePrefixLength in interface AddressSection

Specified by:

removePrefixLength in interface AddressSegmentSeries

Specified by:

removePrefixLength in interface IPAddressSegmentSeries

Specified by:

removePrefixLength in class IPAddressSection

Returns:

See Also:

• for an alternative which does not change the address series values.

withoutPrefixLength

public IPv4AddressSection withoutPrefixLength()

Description copied from interface: AddressSegmentSeries

Provides the same address with no prefix. The values remain unchanged.

Use AddressSegmentSeries.removePrefixLength() as an alternative that deletes the host at the same time by zeroing the host values.

Specified by:

withoutPrefixLength in interface AddressSection

Specified by:

withoutPrefixLength in interface AddressSegmentSeries

Specified by:

withoutPrefixLength in interface IPAddressSegmentSeries

Specified by:

withoutPrefixLength in class IPAddressSection

removePrefixLength

@Deprecated
public IPv4AddressSection removePrefixLength(boolean zeroed)

Deprecated.

Description copied from interface: AddressSegmentSeries

Removes the prefix length. If zeroed is false, the bits that were host bits do not become zero, unlike AddressSegmentSeries.removePrefixLength()

Specified by:

removePrefixLength in interface AddressSection

Specified by:

removePrefixLength in interface AddressSegmentSeries

Specified by:

removePrefixLength in interface IPAddressSegmentSeries

Specified by:

removePrefixLength in class IPAddressSection

Parameters:

zeroed - whether the bits outside the prefix become zero

Returns:

toZeroHost

public IPv4AddressSection toZeroHost()
                              throws IncompatibleAddressException

Description copied from interface: IPAddressSegmentSeries

Returns the segment series with a host of zero, the host being the bits following the prefix length. If the series has no prefix length, then it returns an all-zero series.

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

Specified by:

toZeroHost in interface IPAddressSegmentSeries

Specified by:

toZeroHost in class IPAddressSection

Returns:

Throws:

IncompatibleAddressException

See Also:

• IPAddressSegmentSeries.toZeroNetwork()

toZeroHost

public IPv4AddressSection toZeroHost(int prefixLength)

Description copied from interface: IPAddressSegmentSeries

Produces the series with host values of 0 for the given prefix length.

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

Specified by:

toZeroHost in interface IPAddressSegmentSeries

Specified by:

toZeroHost in class IPAddressSection

Parameters:

prefixLength -

Returns:

toZeroNetwork

public IPv4AddressSection toZeroNetwork()

Description copied from interface: IPAddressSegmentSeries

Returns the segment series with a network of zero, the network being the bits within the prefix length. If the series has no prefix length, then it returns an all-zero series.

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.

Specified by:

toZeroNetwork in interface IPAddressSegmentSeries

Specified by:

toZeroNetwork in class IPAddressSection

Returns:

See Also:

• IPAddressSegmentSeries.toZeroHost()

toMaxHost

public IPv4AddressSection toMaxHost()
                             throws IncompatibleAddressException

Description copied from interface: IPAddressSegmentSeries

Returns the segment series with a host of all ones. If the series has no prefix length, then it returns an all-ones series.

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

Specified by:

toMaxHost in interface IPAddressSegmentSeries

Specified by:

toMaxHost in class IPAddressSection

Returns:

Throws:

IncompatibleAddressException

createMaxHost

public IPv4AddressSection createMaxHost()

toMaxHost

public IPv4AddressSection toMaxHost(int prefixLength)

Description copied from interface: IPAddressSegmentSeries

Produces the series with host values of all one bits for the given prefix length.

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

Specified by:

toMaxHost in interface IPAddressSegmentSeries

Specified by:

toMaxHost in class IPAddressSection

Parameters:

prefixLength -

Returns:

mask

public IPv4AddressSection mask(IPv4AddressSection mask,
 boolean retainPrefix)
                        throws IncompatibleAddressException,
SizeMismatchException

Does the bitwise conjunction with this address. Useful when subnetting.

Parameters:

mask -

retainPrefix - whether to drop the prefix

Returns:

Throws:

IncompatibleAddressException

SizeMismatchException

mask

public IPv4AddressSection mask(IPv4AddressSection mask)
                        throws IncompatibleAddressException,
SizeMismatchException

Equivalent to mask(IPv4AddressSection, boolean) with the second argument as false.

Throws:

IncompatibleAddressException

SizeMismatchException

maskNetwork

public IPv4AddressSection maskNetwork(IPv4AddressSection mask,
 int networkPrefixLength)
                               throws IncompatibleAddressException,
PrefixLenException,
SizeMismatchException

Produces the bitwise conjunction of the given mask with the network section of the address as indicated by the given prefix length. Useful for subnetting. Once you have zeroed a section of the network you can insert bits using bitwiseOr(IPv4AddressSection) or replace(int, IPv4AddressSection)

Parameters:

mask -

networkPrefixLength -

Returns:

Throws:

IncompatibleAddressException

PrefixLenException

SizeMismatchException

bitwiseOr

public IPv4AddressSection bitwiseOr(IPv4AddressSection mask)
                             throws IncompatibleAddressException

Equivalent to bitwiseOr(IPv4AddressSection, boolean) with the second argument as false.

Throws:

IncompatibleAddressException

bitwiseOr

public IPv4AddressSection bitwiseOr(IPv4AddressSection mask,
 boolean retainPrefix)
                             throws IncompatibleAddressException,
SizeMismatchException

Does the bitwise disjunction with this address section. Useful when subnetting. Similar to mask(IPv4AddressSection) which does the bitwise conjunction.

Parameters:

retainPrefix - whether the result will retain the same prefix length as this.

Returns:

Throws:

IncompatibleAddressException

SizeMismatchException

bitwiseOrNetwork

public IPv4AddressSection bitwiseOrNetwork(IPv4AddressSection mask,
 int networkPrefixLength)
                                    throws IncompatibleAddressException,
SizeMismatchException

Does the bitwise disjunction with this address section. Useful when subnetting. Similar to 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.

Parameters:

mask -

Returns:

Throws:

IncompatibleAddressException

SizeMismatchException

getHostMask

public IPv4AddressSection getHostMask()

Description copied from interface: IPAddressSegmentSeries

Returns the host mask associated with the CIDR network prefix length of this series. If this series has no prefix length, then the whole series is considered a host and the all ones host mask is returned.

Specified by:

getHostMask in interface IPAddressSegmentSeries

Overrides:

getHostMask in class IPAddressSection

Returns:

getNetworkMask

public IPv4AddressSection getNetworkMask()

Description copied from interface: IPAddressSegmentSeries

Returns the network mask associated with the CIDR network prefix length of this series. If this series has no prefix length, then the whole series is considered network and the all ones network mask is returned.

Specified by:

getNetworkMask in interface IPAddressSegmentSeries

Overrides:

getNetworkMask in class IPAddressSection

Returns:

getNetworkSection

public IPv4AddressSection getNetworkSection()

Description copied from interface: IPAddressSegmentSeries

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.

Specified by:

getNetworkSection in interface IPAddressSegmentSeries

Returns:

getNetworkSection

public IPv4AddressSection getNetworkSection(int networkPrefixLength)
                                     throws PrefixLenException

Description copied from interface: IPAddressSegmentSeries

Returns the network section of the series. The returned section will have only as many segments as needed as indicated by networkPrefixLength. It will have networkPrefixLength as its associated prefix length, unless this address already has a smaller prefix length, in which case the existing prefix length is retained.

Specified by:

getNetworkSection in interface IPAddressSegmentSeries

Parameters:

networkPrefixLength -

Returns:

Throws:

PrefixLenException

getNetworkSection

public IPv4AddressSection getNetworkSection(int networkPrefixLength,
 boolean withPrefixLength)
                                     throws PrefixLenException

Description copied from interface: IPAddressSegmentSeries

Returns the network section of the series. The returned section will have only as many segments as needed as indicated by networkPrefixLength. If withPrefixLength is true, it will have networkPrefixLength as its associated prefix length, unless this series already has a smaller prefix length, in which case the existing prefix length is retained.

Specified by:

getNetworkSection in interface IPAddressSegmentSeries

Parameters:

networkPrefixLength -

withPrefixLength - whether the resulting section will have networkPrefixLength as the associated prefix length or not

Returns:

Throws:

PrefixLenException

getHostSection

public IPv4AddressSection getHostSection()

Description copied from interface: IPAddressSegmentSeries

Returns the host section of the series. The returned section will have only as many segments as needed as determined by the existing CIDR network prefix length. If this series has no CIDR prefix length, the returned host section will be the full section associated with a prefix length of 0.

Specified by:

getHostSection in interface IPAddressSegmentSeries

Returns:

getHostSection

public IPv4AddressSection getHostSection(int networkPrefixLength)
                                  throws PrefixLenException

Description copied from interface: IPAddressSegmentSeries

Returns the host section of the address as indicated by the network prefix length provided. The returned section will have only as many segments as needed to hold the host as indicated by the provided network prefix length.

Specified by:

getHostSection in interface IPAddressSegmentSeries

Parameters:

networkPrefixLength -

Returns:

Throws:

PrefixLenException

toPrefixBlock

public IPv4AddressSection toPrefixBlock()

Description copied from interface: IPAddressSegmentSeries

If this series has a prefix length, returns the subnet block for that prefix. If this series has no prefix length, this series is returned.

Specified by:

toPrefixBlock in interface AddressSection

Specified by:

toPrefixBlock in interface AddressSegmentSeries

Specified by:

toPrefixBlock in interface IPAddressSegmentSeries

Specified by:

toPrefixBlock in class IPAddressSection

Returns:

the subnet block for the prefix length

toPrefixBlock

public IPv4AddressSection toPrefixBlock(int networkPrefixLength)
                                 throws PrefixLenException

Description copied from interface: IPAddressSegmentSeries

Returns the segment series of the same length that spans all hosts. The network prefix length will be the one provided, and the network values will match the same of this series.

Specified by:

toPrefixBlock in interface IPAddressSegmentSeries

Specified by:

toPrefixBlock in class IPAddressSection

Parameters:

networkPrefixLength -

Returns:

Throws:

PrefixLenException

assignPrefixForSingleBlock

public IPv4AddressSection assignPrefixForSingleBlock()

Description copied from class: IPAddressSection

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.

If no such prefix length exists, returns null.

If this address represents just a single address, "this" is returned.

Specified by:

assignPrefixForSingleBlock in interface IPAddressSegmentSeries

Overrides:

assignPrefixForSingleBlock in class IPAddressSection

Returns:

See Also:

• IPAddressSegmentSeries.toPrefixBlock()
• IPAddressSegmentSeries.assignMinPrefixForBlock()

assignMinPrefixForBlock

public IPv4AddressSection assignMinPrefixForBlock()

Description copied from class: IPAddressSection

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.

Specified by:

assignMinPrefixForBlock in interface IPAddressSegmentSeries

Overrides:

assignMinPrefixForBlock in class IPAddressSection

Returns:

See Also:

• IPAddressSegmentSeries.toPrefixBlock()
• IPAddressSegmentSeries.assignPrefixForSingleBlock()

coverWithPrefixBlock

public IPv4AddressSection coverWithPrefixBlock()

Description copied from interface: IPAddressSegmentSeries

Returns the minimal-size prefix block that covers all the values in this series. The resulting block will have a larger series count than this, unless this series is already a prefix block.

Specified by:

coverWithPrefixBlock in interface IPAddressSegmentSeries

Specified by:

coverWithPrefixBlock in class IPAddressSection

coverWithPrefixBlock

public IPv4AddressSection coverWithPrefixBlock(IPv4AddressSection other)
                                        throws AddressConversionException

Throws:

AddressConversionException

spanWithPrefixBlocks

public IPv4AddressSection[] spanWithPrefixBlocks()

Produces an array of prefix blocks that spans the same set of values.

Unlike spanWithPrefixBlocks(IPv4AddressSection) this method only includes blocks that are a part of this section.

Specified by:

spanWithPrefixBlocks in interface IPAddressSegmentSeries

spanWithPrefixBlocks

public IPv4AddressSection[] spanWithPrefixBlocks(IPv4AddressSection other)

Produces the list of prefix block subnets that span from this series to the given series.

Parameters:

other -

Returns:

spanWithRangedSegments

@Deprecated
public IPv4AddressSection[] spanWithRangedSegments(IPv4AddressSection other)

Deprecated.

use spanWithSequentialBlocks(IPv4AddressSection)

Parameters:

other -

Returns:

spanWithSequentialBlocks

public IPv4AddressSection[] spanWithSequentialBlocks()
                                              throws AddressConversionException

Produces an array of blocks that are sequential that cover the same set of sections as this.

This array can be shorter than that produced by spanWithPrefixBlocks() and is never longer.

Unlike spanWithSequentialBlocks(IPv4AddressSection) this method only includes values that are a part of this section.

Specified by:

spanWithSequentialBlocks in interface IPAddressSegmentSeries

Throws:

AddressConversionException

spanWithSequentialBlocks

public IPv4AddressSection[] spanWithSequentialBlocks(IPv4AddressSection other)

Produces a list of range subnets that span from this series to the given series.

Parameters:

other -

Returns:

mergePrefixBlocks

@Deprecated
public IPv4AddressSection[] mergePrefixBlocks(IPv4AddressSection... sections)
                                       throws SizeMismatchException

Deprecated.

use mergeToPrefixBlocks(IPv4AddressSection...)

Parameters:

sections -

Returns:

Throws:

SizeMismatchException

mergeToPrefixBlocks

public IPv4AddressSection[] mergeToPrefixBlocks(IPv4AddressSection... sections)
                                         throws SizeMismatchException

Merges this with the list of sections to produce the smallest array of prefix blocks.

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());

Parameters:

sections - the sections to merge with this

Returns:

Throws:

SizeMismatchException

mergeToSequentialBlocks

public IPv4AddressSection[] mergeToSequentialBlocks(IPv4AddressSection... sections)
                                             throws SizeMismatchException

Merges this with the list of sections to produce the smallest array of sequential block subnets.

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());

Parameters:

sections - the sections to merge with this

Returns:

Throws:

SizeMismatchException

toCanonicalString

public String toCanonicalString()

This produces a canonical string. If this has a prefix length, that will be included in the string.

Specified by:

toCanonicalString in interface AddressSegmentSeries

Returns:

toFullString

public String toFullString()

This produces a string with no compressed segments and all segments of full length, which is 3 characters for IPv4 segments.

Specified by:

toFullString in interface IPAddressSegmentSeries

toCompressedString

public String toCompressedString()

The shortest string for IPv4 addresses is the same as the canonical string.

Specified by:

toCompressedString in interface AddressSegmentSeries

Returns:

toNormalizedString

public String toNormalizedString()

The normalized string returned by this method is consistent with java.net.Inet4Address, and is the same as toCanonicalString().

Specified by:

toNormalizedString in interface AddressComponent

Returns:

toCompressedWildcardString

public String toCompressedWildcardString()

Description copied from interface: IPAddressSegmentSeries

This is similar to toNormalizedWildcardString, avoiding the CIDR prefix, but with compression as well.

Specified by:

toCompressedWildcardString in interface IPAddressSegmentSeries

toSubnetString

public String toSubnetString()

Description copied from interface: IPAddressSegmentSeries

Produces a consistent subnet string. In the case of IPv4, this means that wildcards are used instead of a network prefix. In the case of IPv6, a prefix will be used and the host section will be compressed with ::.

Specified by:

toSubnetString in interface IPAddressSegmentSeries

toPrefixLengthString

public String toPrefixLengthString()

Description copied from interface: IPAddressSegmentSeries

Returns a string with a CIDR prefix length if this section has a network prefix length. For IPv6, the host section will be compressed with ::, for IPv4 the host section will be zeros.

Specified by:

toPrefixLengthString in interface IPAddressSegmentSeries

Returns:

toInetAtonString

public String toInetAtonString(IPv4Address.inet_aton_radix radix)

toInetAtonString

public String toInetAtonString(IPv4Address.inet_aton_radix radix,
 int joinedCount)
                        throws IncompatibleAddressException

Throws:

IncompatibleAddressException

toNormalizedWildcardString

public String toNormalizedWildcardString()

Description copied from interface: IPAddressSegmentSeries

This produces a string similar to the normalized string and avoids the CIDR prefix. CIDR addresses will be shown with wildcards and ranges instead of using the CIDR prefix notation.

Specified by:

toNormalizedWildcardString in interface IPAddressSegmentSeries

toCanonicalWildcardString

public String toCanonicalWildcardString()

Description copied from interface: IPAddressSegmentSeries

This produces a string similar to the canonical string and avoids the CIDR prefix. Addresses with a network prefix length will be shown with wildcards and ranges instead of using the CIDR prefix length notation. IPv6 addresses will be compressed according to the canonical representation.

Specified by:

toCanonicalWildcardString in interface IPAddressSegmentSeries

toSQLWildcardString

public String toSQLWildcardString()

Description copied from interface: IPAddressSegmentSeries

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

Specified by:

toSQLWildcardString in interface IPAddressSegmentSeries

toReverseDNSLookupString

public String toReverseDNSLookupString()

Description copied from interface: IPAddressSegmentSeries

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

Specified by:

toReverseDNSLookupString in interface IPAddressSegmentSeries

Returns:

toSegmentedBinaryString

public String toSegmentedBinaryString()

Description copied from interface: IPAddressSegmentSeries

Writes this IP address segment series as a segments of binary values preceded by the "0b" prefix.

Specified by:

toSegmentedBinaryString in interface IPAddressSegmentSeries

toNormalizedString

public String toNormalizedString(IPAddressSection.IPStringOptions stringParams,
 int joinCount)
                          throws IncompatibleAddressException

Throws:

IncompatibleAddressException

toJoinedSegments

public IPAddressDivisionGrouping toJoinedSegments(int joinCount)

toAllStringCollection

public IPAddressPartStringCollection toAllStringCollection()

Description copied from class: IPAddressSection

Use this method with care... a single IPv6 address can have thousands of string representations. Examples: "::" has 1297 such variations, but only 9 are considered standard "a:b:c:0:d:e:f:1" has 1920 variations, but only 12 are standard Variations included in this method: -all standard variations -choosing specific segments for full leading zeros (::a:b can be ::000a:b, ::a:000b, or ::000a:000b) -choosing which zero-segments to compress (0:0:a:: can be ::a:0:0:0:0:0 or 0:0:a::) -mixed representation (1:2:3:4:5:6:1.2.3.4) -all combinations of such variations Variations omitted from this method: -mixed case of a-f, which you can easily handle yourself with String.equalsIgnoreCase -adding a variable number of leading zeros (::a can be ::0a, ::00a, ::000a) -choosing any number of zero-segments anywhere to compress (:: can be 0:0:0::0:0)

Overrides:

toAllStringCollection in class IPAddressSection

Returns:

toStandardStringCollection

public IPAddressPartStringCollection toStandardStringCollection()

Description copied from class: IPAddressSection

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

Overrides:

toStandardStringCollection in class IPAddressSection

Returns:

toDatabaseSearchStringCollection

public IPAddressPartStringCollection toDatabaseSearchStringCollection()

Description copied from class: IPAddressSection

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

Overrides:

toDatabaseSearchStringCollection in class IPAddressSection

Returns:

toStringCollection

public IPAddressPartStringCollection toStringCollection(IPAddressSection.IPStringBuilderOptions opts)

Specified by:

toStringCollection in interface IPAddressSegmentSeries

toStringCollection

public IPAddressPartStringCollection toStringCollection(IPv4AddressSection.IPv4StringBuilderOptions opts)

getParts

public IPAddressStringDivisionSeries[] getParts(IPAddressSection.IPStringBuilderOptions options)

Description copied from class: IPAddressSection

Get all representations of this address including this IPAddressSection. This includes:

• alternative segment groupings expressed as IPAddressDivisionGrouping
• conversions to IPv6, and alternative representations of those IPv6 addresses

Overrides:

getParts in class IPAddressSection

Parameters:

options -

Returns:

getParts

public IPAddressStringDivisionSeries[] getParts(IPv4AddressSection.IPv4StringBuilderOptions options)