Module inet.ipaddr
Package inet.ipaddr.format.standard

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

    Author:
    sfoley
    See Also:
    Serialized Form

    • Constructor Detail

      • IPAddressDivisionGrouping

        public IPAddressDivisionGrouping​(IPAddressDivision[] divisions,
                                 IPAddressNetwork<?,​?,​?,​?,​?> network)
                          throws AddressValueException
        Constructs a grouping of IPAddress divisions.

        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)

        Parameters:
        divisions -
        network -
        Throws:
        java.lang.NullPointerException - if network is null or a division is null
        AddressValueException

    • Method Detail

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

        This method applies only to the lower value of the range if this division represents multiple values.

        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.

        This method applies only to the lower value of the range if this division represents multiple values.

        Parameters:
        network -
        Returns:

      • 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