inet.ipaddr.format.standard

Class IPAddressDivisionGrouping

java.lang.Object

inet.ipaddr.format.AddressDivisionGroupingBase

inet.ipaddr.format.standard.AddressDivisionGrouping

inet.ipaddr.format.standard.IPAddressDivisionGrouping

All Implemented Interfaces:

AddressDivisionSeries, AddressItem, IPAddressDivisionSeries, AddressStringDivisionSeries, IPAddressStringDivisionSeries, java.io.Serializable, java.lang.Comparable<AddressItem>

Direct Known Subclasses:

IPAddressSection, IPv6AddressSection.IPv6v4MixedAddressSection

public class IPAddressDivisionGrouping
extends AddressDivisionGrouping
implements IPAddressDivisionSeries

IPAddressDivisionGrouping objects consist of a series of IPAddressDivision objects, each division containing one or more segments.

With the IPAddressSection subclass, each division is one segment (eg either groupings of 4 like 1.2.3.4 or groupings of 8 like 1:2:3:4:5:6:7:8).

For IPv6, a compressed segment still counts as one of the groupings, it is simply not printed as part of the text representation.

Alternative groupings include ipv4 groupings define by inet_aton (eg groupings of 1, 2, or 3 divisions like 1, 1.2, and 1.2.3) and the mixed ipv6/ipv4 representation of ipv6 addresses (eg a grouping of 10 divisions like a:b:c:d:e:f:1.2.3.4)

IPAddressDivisionGrouping objects are immutable. Some of the derived state is created upon demand and cached. This also makes them thread-safe.

IPAddressDivisionGrouping objects may be associated with a prefix length, in which case that number of bits in the upper-most portion of the object represent a prefix, while the remaining bits assume all possible values.

IPAddressDivision objects use long to represent their values, so this places a cap on the size of the divisions in IPAddressDivisionGrouping.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IPAddressDivisionGrouping.Range
static class	IPAddressDivisionGrouping.RangeList

Nested classes/interfaces inherited from class inet.ipaddr.format.standard.AddressDivisionGrouping

AddressDivisionGrouping.StringOptions

Constructor Summary

Constructors

Constructor and Description
IPAddressDivisionGrouping(IPAddressDivision[] divisions, IPAddressNetwork<?,?,?,?,?> network) If the grouping is prefixed, then note that we allow both null:null:x:0:0 where is x is the division bit count and null:null:0:0:0 which essentially have the same overall prefix grouping prefix.

Method Summary

Modifier and Type	Method and Description
boolean	containsPrefixBlock(int prefixLength) Returns whether the values of this division grouping contain the prefix block for the given prefix length
boolean	containsSinglePrefixBlock(int prefixLength) Returns whether the values of this division grouping match the prefix block for the given prefix length
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.
IPAddressDivision	getDivision(int index)
int	getLeadingBitCount(boolean network) Returns the number of consecutive leading one or zero bits.
IPAddressNetwork<?,?,?,?,?>	getNetwork()
java.lang.Integer	getNetworkPrefixLength() Returns the CIDR network prefix length of the series, or null if the series has no associated prefix length.
java.lang.Integer	getPrefixLength() The bit-length of the portion of the address that is not specific to an individual address but common amongst a group of addresses.
java.lang.Integer	getPrefixLengthForSingleBlock() Returns a prefix length for which the range of this segment grouping matches the the block of addresses for that prefix.
int	getTrailingBitCount(boolean network) Returns the number of consecutive trailing one or zero bits.
IPAddressDivisionGrouping.RangeList	getZeroRangeSegments()
IPAddressDivisionGrouping.RangeList	getZeroSegments()
boolean	includesZeroHost()
int	isMore(AddressDivisionSeries other) Use this method to compare the counts of two address series.
boolean	isPrefixBlock() Returns whether this address section represents a subnet block of addresses associated its prefix length.
boolean	isSinglePrefixBlock() Returns whether the division grouping range matches the block of values for its prefix length.

Methods inherited from class inet.ipaddr.format.standard.AddressDivisionGrouping

hashCode

Methods inherited from class inet.ipaddr.format.AddressDivisionGroupingBase

getBytes, getBytes, getBytes, getCount, getDivisionCount, getDivisionStrings, getMinPrefixLengthForBlock, getPrefixCount, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isPrefixed, isZero, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface inet.ipaddr.format.AddressDivisionSeries

getBitCount, getBlockCount, getCount, getDivisionStrings, getPrefixCount, getPrefixCount, isPrefixed, isSequential

Methods inherited from interface inet.ipaddr.format.AddressItem

compareTo, getByteCount, getBytes, getBytes, getBytes, getMinPrefixLengthForBlock, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isZero, testRange, testRange

Methods inherited from interface inet.ipaddr.format.string.IPAddressStringDivisionSeries

isPrefixed

Methods inherited from interface inet.ipaddr.format.string.AddressStringDivisionSeries

getDivisionCount

Constructor Detail

IPAddressDivisionGrouping

public IPAddressDivisionGrouping(IPAddressDivision[] divisions,
                                 IPAddressNetwork<?,?,?,?,?> network)
                          throws AddressValueException

If the grouping is prefixed, then note that we allow both null:null:x:0:0 where is x is the division bit count and null:null:0:0:0 which essentially have the same overall prefix grouping prefix. For further discussion of this, see AddressDivisionGrouping.normalizePrefixBoundary(int, IPAddressSegment[], int, int, java.util.function.BiFunction)

Parameters:

divisions -

network -

Throws:

java.lang.NullPointerException - if network is null or a division is null

AddressValueException

Method Detail

getNetwork

public IPAddressNetwork<?,?,?,?,?> getNetwork()

Specified by:

getNetwork in interface IPAddressStringDivisionSeries

getDivision

public IPAddressDivision getDivision(int index)

Specified by:

getDivision in interface AddressDivisionSeries

Specified by:

getDivision in interface IPAddressDivisionSeries

Specified by:

getDivision in interface AddressStringDivisionSeries

Specified by:

getDivision in interface IPAddressStringDivisionSeries

Overrides:

getDivision in class AddressDivisionGrouping

Returns:

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

isMore

public int isMore(AddressDivisionSeries other)

Description copied from interface: AddressDivisionSeries

Use this method to compare the counts of two address series. Rather than calculating counts with getCount(), there can be more efficient ways of comparing whether one series represents more individual address series than another.

Specified by:

isMore in interface AddressDivisionSeries

Returns:

a positive integer if this AddressDivisionSeries has a larger count than the provided, 0 if they are the same, a negative integer if the other has a larger count.

getPrefixLength

public java.lang.Integer getPrefixLength()

Description copied from interface: AddressDivisionSeries

The bit-length of the portion of the address that is not specific to an individual address but common amongst a group of addresses.

Typically this is the largest number of bits in the upper-most portion of the section for which the remaining bits assume all possible values.

For IP addresses, this must be explicitly defined when the address is created. For example, 1.2.0.0/16 has a prefix length of 16, while 1.2.*.* has no prefix length, even though they both represent the same set of addresses and are considered equal. Prefixes can be considered variable for any given IP addresses and can depend on the routing table.

The methods AddressItem.getMinPrefixLengthForBlock() and AddressItem.getPrefixLengthForSingleBlock() can help you to obtain or define a prefix length if one does not exist already. 1.2.0.0/16 and 1.2.*.* both the same equivalent and minimum prefix length of 16.

For MAC addresses, the prefix is initially defined by the range, so 1:2:3:*:*:* has a prefix length of 24 by definition. Addresses derived from the original may retain the original prefix length regardless of their range.

Specified by:

getPrefixLength in interface AddressDivisionSeries

Specified by:

getPrefixLength in interface IPAddressStringDivisionSeries

Overrides:

getPrefixLength in class AddressDivisionGroupingBase

Returns:

the prefix length or null if there is none

getNetworkPrefixLength

public java.lang.Integer getNetworkPrefixLength()

Description copied from interface: IPAddressDivisionSeries

Returns the CIDR network prefix length of the series, or null if the series has no associated prefix length.

Equivalent to AddressDivisionSeries.getPrefixLength(), which is the more general concept of set of address series that share the same set of leading bits. For IP addresses and sections the prefix length and the CIDR network prefix length are the same thing.

For IP addresses and sections each individual segment has an associated prefix length which is determine by the network prefix length. The segment prefix lengths follow the pattern: null, null, ...., null, x, 0, 0, ..., 0

For instance, an IPv4 address 1.2.3.4/16 has the network prefix length 16. The segment prefix lengths are [null, 8, 0, 0] The segment prefix lengths of 1.2.3.4/22 are [null, null, 6, 0]

Specified by:

getNetworkPrefixLength in interface IPAddressDivisionSeries

Returns:

getTrailingBitCount

public int getTrailingBitCount(boolean network)

Returns the number of consecutive trailing one or zero bits. If network is true, returns the number of consecutive trailing zero bits. Otherwise, returns the number of consecutive trailing one bits.

Parameters:

network -

Returns:

getLeadingBitCount

public int getLeadingBitCount(boolean network)

Returns the number of consecutive leading one or zero bits. If network is true, returns the number of consecutive leading one bits. Otherwise, returns the number of consecutive leading zero bits.

Parameters:

network -

Returns:

isPrefixBlock

public boolean isPrefixBlock()

Returns whether this address section represents a subnet block of addresses associated its prefix length. Returns false if it has no prefix length, if it is a single address with a prefix length (ie not a subnet), or if it is a range of addresses that does not include the entire subnet block for its prefix length. If AddressNetwork.getPrefixConfiguration() is set to consider all prefixes as subnets, this returns true for any grouping with prefix length.

Specified by:

isPrefixBlock in interface AddressDivisionSeries

Specified by:

isPrefixBlock in interface IPAddressStringDivisionSeries

Overrides:

isPrefixBlock in class AddressDivisionGroupingBase

Returns:

containsPrefixBlock

public boolean containsPrefixBlock(int prefixLength)

Description copied from class: AddressDivisionGrouping

Returns whether the values of this division grouping contain the prefix block for the given prefix length

Specified by:

containsPrefixBlock in interface AddressItem

Overrides:

containsPrefixBlock in class AddressDivisionGrouping

Returns:

containsSinglePrefixBlock

public boolean containsSinglePrefixBlock(int prefixLength)

Description copied from class: AddressDivisionGrouping

Returns whether the values of this division grouping match the prefix block for the given prefix length

Specified by:

containsSinglePrefixBlock in interface AddressItem

Overrides:

containsSinglePrefixBlock in class AddressDivisionGrouping

Returns:

isSinglePrefixBlock

public boolean isSinglePrefixBlock()

Returns whether the division grouping range matches the block of values for its prefix length. In other words, returns true if and only if it has a prefix length and it has just a single prefix.

Specified by:

isSinglePrefixBlock in interface AddressDivisionSeries

Overrides:

isSinglePrefixBlock in class AddressDivisionGroupingBase

Returns:

getPrefixLengthForSingleBlock

public java.lang.Integer getPrefixLengthForSingleBlock()

Description copied from class: AddressDivisionGroupingBase

Returns a prefix length for which the range of this segment grouping matches the the block of addresses for that prefix. If no such prefix exists, returns null If this segment grouping represents a single value, returns the bit length

Specified by:

getPrefixLengthForSingleBlock in interface AddressItem

Overrides:

getPrefixLengthForSingleBlock in class AddressDivisionGroupingBase

Returns:

the prefix length or null

includesZeroHost

public boolean includesZeroHost()

equals

public boolean equals(java.lang.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 AddressDivisionGrouping

getZeroSegments

public IPAddressDivisionGrouping.RangeList getZeroSegments()

Returns:

the segments which are zero

getZeroRangeSegments

public IPAddressDivisionGrouping.RangeList getZeroRangeSegments()

Returns:

the segments which are zero or whose prefix-based range includes 0