public class IPAddressDivisionGrouping extends AddressDivisionGrouping implements IPAddressDivisionSeries
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.
| Modifier and Type | Class and Description |
|---|---|
static class |
IPAddressDivisionGrouping.Range |
static class |
IPAddressDivisionGrouping.RangeList |
AddressDivisionGrouping.DivisionLengthProvider, AddressDivisionGrouping.DivisionValueProvider, AddressDivisionGrouping.StringOptions| Constructor and Description |
|---|
IPAddressDivisionGrouping(IPAddressDivision[] divisions,
IPAddressNetwork<?,?,?,?,?> network)
Constructs a grouping of IPAddress divisions.
|
| 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(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() |
Integer |
getNetworkPrefixLength()
Returns the CIDR network prefix length of the series, or null if the series has no associated prefix length.
|
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.
|
Integer |
getPrefixLengthForSingleBlock()
Returns a prefix length for which the range of this segment grouping matches 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.
|
hashCodegetBytes, getBytes, getBytes, getCount, getDivisionCount, getDivisionStrings, getMinPrefixLengthForBlock, getPrefixCount, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isPrefixed, isSequential, isZero, toStringgetBitCount, getBlockCount, getCount, getDivisionStrings, getPrefixCount, getPrefixCount, getSequentialBlockIndex, isPrefixed, isSequentialcompareTo, getBitsForCount, getBlockSize, getByteCount, getBytes, getBytes, getBytes, getMinPrefixLengthForBlock, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isZeroisPrefixedgetDivisionCountpublic IPAddressDivisionGrouping(IPAddressDivision[] divisions, IPAddressNetwork<?,?,?,?,?> network) throws AddressValueException
Note: If the grouping is prefixed and the prefix length aligns with a division boundary,
then we allow as division prefix lengths both
null:null:x:0:0 where is x is the division bit count and
null:null:null:0:0, which are essentially equivalent.
The overall prefix length of this example grouping is the division bit count tripled.
For further discussion of this, see AddressDivisionGrouping.normalizePrefixBoundary(int, IPAddressSegment[], int, int, java.util.function.Function)
divisions - network - NullPointerException - if network is null or a division is nullAddressValueExceptionpublic IPAddressNetwork<?,?,?,?,?> getNetwork()
getNetwork in interface IPAddressStringDivisionSeriespublic IPAddressDivision getDivision(int index)
getDivision in interface AddressDivisionSeriesgetDivision in interface IPAddressDivisionSeriesgetDivision in interface AddressStringDivisionSeriesgetDivision in interface IPAddressStringDivisionSeriesgetDivision in class AddressDivisionGroupingpublic int isMore(AddressDivisionSeries other)
AddressDivisionSeriesisMore in interface AddressDivisionSeriespublic Integer getPrefixLength()
AddressDivisionSeriesTypically 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.
getPrefixLength in interface AddressDivisionSeriesgetPrefixLength in interface IPAddressStringDivisionSeriesgetPrefixLength in class AddressDivisionGroupingBasepublic Integer getNetworkPrefixLength()
IPAddressDivisionSeries
Equivalent to AddressDivisionSeries.getPrefixLength(),
which is the more general concept of set of address series that share the same set of leading bits.
For IP addresses and sections the prefix length and the CIDR network prefix length are the same thing.
For IP addresses and sections each individual segment has an associated prefix length which is determine by the network prefix length. The segment prefix lengths follow the pattern: null, null, ...., null, x, 0, 0, ..., 0
For instance, an IPv4 address 1.2.3.4/16 has the network prefix length 16. The segment prefix lengths are [null, 8, 0, 0] The segment prefix lengths of 1.2.3.4/22 are [null, null, 6, 0]
getNetworkPrefixLength in interface IPAddressDivisionSeriespublic int getTrailingBitCount(boolean network)
This method applies only to the lower value of the range if this division represents multiple values.
network - public int getLeadingBitCount(boolean network)
This method applies only to the lower value of the range if this division represents multiple values.
network - public boolean isPrefixBlock()
AddressNetwork.getPrefixConfiguration() is set to consider all prefixes as subnets, this returns true for any grouping with prefix length.isPrefixBlock in interface AddressDivisionSeriesisPrefixBlock in interface IPAddressStringDivisionSeriesisPrefixBlock in class AddressDivisionGroupingBasepublic boolean containsPrefixBlock(int prefixLength)
AddressDivisionGroupingcontainsPrefixBlock in interface AddressItemcontainsPrefixBlock in class AddressDivisionGroupingpublic boolean containsSinglePrefixBlock(int prefixLength)
AddressDivisionGroupingcontainsSinglePrefixBlock in interface AddressItemcontainsSinglePrefixBlock in class AddressDivisionGroupingpublic boolean isSinglePrefixBlock()
isSinglePrefixBlock in interface AddressDivisionSeriesisSinglePrefixBlock in class AddressDivisionGroupingBasepublic Integer getPrefixLengthForSingleBlock()
AddressDivisionGroupingBasegetPrefixLengthForSingleBlock in interface AddressItemgetPrefixLengthForSingleBlock in class AddressDivisionGroupingBasepublic boolean includesZeroHost()
public boolean equals(Object o)
AddressDivisionGroupingBaseequals in class AddressDivisionGroupingpublic IPAddressDivisionGrouping.RangeList getZeroSegments()
public IPAddressDivisionGrouping.RangeList getZeroRangeSegments()