inet.ipaddr

Interface AddressSegment

  • All Superinterfaces:
    AddressComponent, AddressItem, java.lang.Comparable<AddressDivision>, java.io.Serializable
    All Known Implementing Classes:
    IPAddressSegment, IPv4AddressSegment, IPv6AddressSegment, MACAddressSegment

    public interface AddressSegment
extends AddressComponent, java.lang.Comparable<AddressDivision>
    This represents a single segment of an address. The current implementations of this class are the most common representations of IPv4, IPv6 and MAC; segments are 1 byte for Ipv4, they are two bytes for Ipv6, and they are 1 byte for MAC addresses. There are alternative forms of dividing addresses into segments, such as dotted representation for MAC like 1111.2222.3333, embedded IPv4 representation for IPv6 like f:f:f:f:f:f:1.2.3.4, inet_aton formats like 1.2 for IPv4, and so on. If those alternative representations were to follow the general rules for segment representation, then you could reuse this class. The general rules are that segments have a whole number of bytes, and in a given address all segments have the same length. When alternatives forms do not follow the general rules for segments, you can use the AddressDivision interface instead. Divisions do not have the restriction that divisions of an address are equal length and a whole number of bytes. Divisions can be grouped using AddressDivisionGrouping. AddressSegment objects are immutable and thus also thread-safe.
    Core

    • Method Detail

      • getLowerSegmentValue

        int getLowerSegmentValue()
        returns the lower value

      • getUpperSegmentValue

        int getUpperSegmentValue()
        returns the upper value

      • getLower

        AddressSegment getLower()
        If this segment represents a range of values, returns a segment representing just the lowest value in the range, otherwise returns this.
        Specified by:
        getLower in interface AddressComponent
        Returns:

      • getUpper

        AddressSegment getUpper()
        If this segment represents a range of values, returns a segment representing just the highest value in the range, otherwise returns this.
        Specified by:
        getUpper in interface AddressComponent
        Returns:

      • reverseBits

        AddressSegment reverseBits(boolean perByte)
        Description copied from interface: AddressComponent
        Returns a new AddressComponent with the bits reversed. If this component represents a range of values that cannot be reversed, then this throws AddressTypeException. In a range the most significant bits stay constant while the least significant bits range over different values, so reversing that scenario results in a series of non-consecutive values, in most cases, which cannot be represented with a single AddressComponent object. In such cases where isMultiple() is true, call iterator(), getLower(), getUpper() or some other methods to break the series down into a series representing a single value.
        Specified by:
        reverseBits in interface AddressComponent
        Parameters:
        perByte - if true, only the bits in each byte are reversed, if false, then all bits in the component are reversed
        Returns:

      • reverseBytes

        AddressSegment reverseBytes()
        Description copied from interface: AddressComponent
        Returns an AddressComponent with the bytes reversed. If this component represents a range of values that cannot be reversed, then this throws AddressTypeException. In a range the most significant bits stay constant while the least significant bits range over different values, so reversing that scenario results in a series of non-consecutive values, in most cases, which cannot be represented with a single AddressComponent object. In such cases where isMultiple() is true, call iterator(), getLower(), getUpper() or some other methods to break the series down into a series representing a single value.
        Specified by:
        reverseBytes in interface AddressComponent
        Returns:

      • iterator

        java.util.Iterator<? extends AddressSegment> iterator()
        Description copied from interface: AddressComponent
        An address component can represent a single segment, address, or section, or it can represent multiple, typically a subnet or range of segment, address, or section values. Call AddressItem.isMultiple() to determine if this instance represents multiple. This method iterates through the individual elements.
        Specified by:
        iterator in interface AddressComponent
        Returns:

      • matches

        boolean matches(int value)

      • matchesWithMask

        boolean matchesWithMask(int value,
                        int mask)

      • equals

        boolean equals(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getMaxSegmentValue

        int getMaxSegmentValue()
        Gets the maximum possible value for this type of segment (for the highest range value of this particular segment, use getUpper()
        Returns:
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method