inet.ipaddr

Class IPAddressSegment

java.lang.Object

inet.ipaddr.format.AddressDivisionBase

inet.ipaddr.format.standard.AddressDivision

inet.ipaddr.format.standard.IPAddressDivision

inet.ipaddr.IPAddressSegment

All Implemented Interfaces:

AddressComponent, AddressSegment, AddressGenericDivision, AddressItem, AddressItemRange, IPAddressGenericDivision, AddressStringDivision, IPAddressStringDivision, java.io.Serializable, java.lang.Comparable<AddressItem>

Direct Known Subclasses:

IPv4AddressSegment, IPv6AddressSegment

public abstract class IPAddressSegment
extends IPAddressDivision
implements AddressSegment

This represents a single segment of an IP address. For IPv4, segments are 1 byte. For IPv6, they are two bytes. IPAddressSegment objects are immutable and thus also thread-safe.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static int	getBitCount(IPAddress.IPVersion version)
static int	getByteCount(IPAddress.IPVersion version)
static int	getDefaultTextualRadix(IPAddress.IPVersion version)
long	getDivisionValue() returns the lower value as a long, although for individual segments getSegmentValue() provides the same value as an int
long	getDivisionValueCount()
abstract IPAddress.IPVersion	getIPVersion()
abstract java.lang.Iterable<? extends IPAddressSegment>	getIterable() Useful for using an instance in a "for-each loop".
abstract IPAddressSegment	getLower() If this segment represents a range of values, returns a segment representing just the lowest value in the range, otherwise returns this.
static int	getMaxSegmentValue(IPAddress.IPVersion version)
long	getMaxValue()
int	getMinPrefixLengthForBlock() Returns the smallest prefix length possible such that this item includes the block of all values for that prefix length.
abstract IPAddressNetwork<?,?,?,?,?>	getNetwork()
int	getPrefixValueCount() Counts the number of prefixes in this address segment.
java.lang.Integer	getSegmentPrefixLength()
int	getSegmentValue() returns the lower value
abstract IPAddressSegment	getUpper() If this segment represents a range of values, returns a segment representing just the highest value in the range, otherwise returns this.
long	getUpperDivisionValue() returns the lower upper value as a long, although for individual segments getUpperSegmentValue() provides the same value as an int
int	getUpperSegmentValue() returns the upper value
int	getValueCount()
int	hashCode()
boolean	includesMax()
boolean	includesZero()
boolean	isBitwiseOrCompatibleWithRange(int maskValue, java.lang.Integer segmentPrefixLength) Similar to masking, checks that the range resulting from the bitwise or is contiguous.
boolean	isBoundedBy(int value) Returns true if the possible values of this division fall below the given value.
boolean	isIPv4()
boolean	isIPv6()
boolean	isMaskCompatibleWithRange(int maskValue, java.lang.Integer segmentPrefixLength) Check that the range resulting from the mask is contiguous, otherwise we cannot represent it.
boolean	isMultiple() Whether this represents multiple potential values (eg a prefixed address or a segment representing a range of values)
boolean	isPrefixBlock() Returns whether the division range includes the block of values for its prefix length
abstract java.util.Iterator<? extends IPAddressSegment>	iterator() Iterates through the individual elements of this address component.
boolean	matches(int value)
boolean	matchesWithMask(int value, int mask)
boolean	matchesWithMask(int lowerValue, int upperValue, int mask)
boolean	matchesWithPrefixMask(int value, java.lang.Integer segmentPrefixLength)
abstract java.util.Iterator<? extends IPAddressSegment>	prefixBlockIterator() Iterates through the individual prefix blocks.
abstract java.util.Iterator<? extends IPAddressSegment>	prefixBlockIterator(int prefixLength) Iterates through the individual prefix blocks according to the given segment prefix length.
boolean	prefixEquals(AddressSegment other, int prefixLength)
boolean	prefixEquals(IPAddressSegment other)
abstract java.util.Iterator<? extends IPAddressSegment>	prefixIterator() Iterates through the individual prefixes.
abstract IPAddressSegment	removePrefixLength()
abstract IPAddressSegment	removePrefixLength(boolean zeroed)
abstract IPAddressSegment	reverseBits(boolean perByte) Returns a new AddressComponent with the bits reversed.
abstract IPAddressSegment	reverseBytes() Returns an AddressComponent with the bytes reversed.
java.lang.String	toHexString(boolean with0xPrefix) Writes this address component as a single hexadecimal value with always the exact same number of characters, with or without a preceding 0x prefix.
abstract IPAddressSegment	toHostSegment(java.lang.Integer segmentPrefixLength) used by getHostSection, see IPAddressSegmentSeries.getHostSection(int)
IPAddressSegment	toNetworkSegment(java.lang.Integer segmentPrefixLength) used by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)
abstract IPAddressSegment	toNetworkSegment(java.lang.Integer segmentPrefixLength, boolean withPrefixLength) used by getNetworkSection and by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)
java.lang.String	toNormalizedString() Produces a string that is consistent for all address components of the same type and version.
java.lang.String	toNormalizedString(IPAddressSection.IPStringOptions options)
abstract IPAddressSegment	withoutPrefixLength()

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

containsPrefixBlock, containsSinglePrefixBlock, getBlockMaskPrefixLength, getDivisionPrefixLength, getPrefixAdjustedRangeString, getString, getWildcardString, isPrefixed, isSinglePrefixBlock, matchesWithPrefixMask

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

equals, getCount, getDigitCount, getDivisionPrefixCount, getMaxDigitCount, getPrefixCount, getPrefixLengthForSingleBlock, getUpperValue, getValue, hasUppercaseVariations, isMax, isZero, matches, matchesWithMask, matchesWithMask

Methods inherited from class inet.ipaddr.format.AddressDivisionBase

getBytes, getBytes, getBytes, getDigitCount, getLowerStandardString, getStandardString, getUpperBytes, getUpperBytes, getUpperBytes, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface inet.ipaddr.AddressSegment

contains, equals, getMaxSegmentValue

Methods inherited from interface inet.ipaddr.format.AddressItem

compareTo, containsPrefixBlock, containsSinglePrefixBlock, getBitCount, getByteCount, getBytes, getBytes, getBytes, getCount, getPrefixCount, getPrefixLengthForSingleBlock, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, isFullRange, isMax, isZero, testRange, testRange

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

getDigitCount, getLowerStandardString, getMaxDigitCount, getStandardString

Methods inherited from interface inet.ipaddr.format.IPAddressGenericDivision

isFullRange

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

getBitCount

Method Detail

getNetwork

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

Specified by:

getNetwork in interface AddressSegment

isIPv4

public boolean isIPv4()

isIPv6

public boolean isIPv6()

getIPVersion

public abstract IPAddress.IPVersion getIPVersion()

getMinPrefixLengthForBlock

public int getMinPrefixLengthForBlock()

Description copied from interface: AddressItem

Returns the smallest prefix length possible such that this item includes the block of all values for that prefix length.

If the entire range can be dictated this way, then this method returns the same value as AddressItem.getPrefixLengthForSingleBlock(). Otherwise, this method will return the minimal possible prefix that can be paired with this address, while AddressItem.getPrefixLengthForSingleBlock() will return null.

In cases where the final bit is constant so there is no such block, this returns the bit count.

Specified by:

getMinPrefixLengthForBlock in interface AddressItem

Overrides:

getMinPrefixLengthForBlock in class AddressDivision

Returns:

the prefix length

getMaxSegmentValue

public static int getMaxSegmentValue(IPAddress.IPVersion version)

isPrefixBlock

public boolean isPrefixBlock()

Description copied from interface: IPAddressStringDivision

Returns whether the division range includes the block of values for its prefix length

Specified by:

isPrefixBlock in interface IPAddressStringDivision

Overrides:

isPrefixBlock in class IPAddressDivision

Returns:

whether the division range includes the block of values for the division prefix length, or false if the division has no prefix length

toNetworkSegment

public IPAddressSegment toNetworkSegment(java.lang.Integer segmentPrefixLength)

used by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)

toNetworkSegment

public abstract IPAddressSegment toNetworkSegment(java.lang.Integer segmentPrefixLength,
                                                  boolean withPrefixLength)

used by getNetworkSection and by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)

toHostSegment

public abstract IPAddressSegment toHostSegment(java.lang.Integer segmentPrefixLength)

used by getHostSection, see IPAddressSegmentSeries.getHostSection(int)

isMaskCompatibleWithRange

public boolean isMaskCompatibleWithRange(int maskValue,
                                         java.lang.Integer segmentPrefixLength)
                                  throws PrefixLenException

Check that the range resulting from the mask is contiguous, otherwise we cannot represent it. For instance, for the range 0 to 3 (bits are 00 to 11), if we mask all 4 numbers from 0 to 3 with 2 (ie bits are 10), then we are left with 1 and 3. 2 is not included. So we cannot represent 1 and 3 as a contiguous range. The underlying rule is that mask bits that are 0 must be above the resulting range in each segment. Any bit in the mask that is 0 must not fall below any bit in the masked segment range that is different between low and high. Any network mask must eliminate the entire segment range. Any host mask is fine.

Parameters:

maskValue -

segmentPrefixLength -

Returns:

Throws:

PrefixLenException

isBitwiseOrCompatibleWithRange

public boolean isBitwiseOrCompatibleWithRange(int maskValue,
                                              java.lang.Integer segmentPrefixLength)
                                       throws PrefixLenException

Similar to masking, checks that the range resulting from the bitwise or is contiguous.

Parameters:

maskValue -

segmentPrefixLength -

Returns:

Throws:

PrefixLenException

getLower

public abstract IPAddressSegment 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

Specified by:

getLower in interface AddressSegment

Specified by:

getLower in interface AddressItemRange

Returns:

getUpper

public abstract IPAddressSegment 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

Specified by:

getUpper in interface AddressSegment

Specified by:

getUpper in interface AddressItemRange

Returns:

getIterable

public abstract java.lang.Iterable<? extends IPAddressSegment> getIterable()

Description copied from interface: AddressItemRange

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

Specified by:

getIterable in interface AddressComponent

Specified by:

getIterable in interface AddressSegment

Specified by:

getIterable in interface AddressItemRange

Returns:

iterator

public abstract java.util.Iterator<? extends IPAddressSegment> iterator()

Description copied from interface: AddressComponent

Iterates through the individual elements of this address component.

An address component can represent a single 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.

Specified by:

iterator in interface AddressComponent

Specified by:

iterator in interface AddressSegment

Specified by:

iterator in interface AddressItemRange

Returns:

prefixBlockIterator

public abstract java.util.Iterator<? extends IPAddressSegment> prefixBlockIterator()

Iterates through the individual prefix blocks.

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

prefixIterator

public abstract java.util.Iterator<? extends IPAddressSegment> prefixIterator()

Iterates through the individual prefixes.

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

prefixBlockIterator

public abstract java.util.Iterator<? extends IPAddressSegment> prefixBlockIterator(int prefixLength)

Iterates through the individual prefix blocks according to the given segment prefix length. Any existing prefix length is disregarded.

getBitCount

public static int getBitCount(IPAddress.IPVersion version)

getByteCount

public static int getByteCount(IPAddress.IPVersion version)

getDefaultTextualRadix

public static int getDefaultTextualRadix(IPAddress.IPVersion version)

matches

public boolean matches(int value)

Specified by:

matches in interface AddressSegment

matchesWithPrefixMask

public boolean matchesWithPrefixMask(int value,
                                     java.lang.Integer segmentPrefixLength)

matchesWithMask

public boolean matchesWithMask(int value,
                               int mask)

Specified by:

matchesWithMask in interface AddressSegment

matchesWithMask

public boolean matchesWithMask(int lowerValue,
                               int upperValue,
                               int mask)

Specified by:

matchesWithMask in interface AddressSegment

getValueCount

public int getValueCount()

Specified by:

getValueCount in interface AddressSegment

Returns:

the same value as AddressItem.getCount() as an integer

getPrefixValueCount

public int getPrefixValueCount()

Counts the number of prefixes in this address segment.

If this segment has no prefix length, this is equivalent to getValueCount()

Returns:

getDivisionValueCount

public long getDivisionValueCount()

Overrides:

getDivisionValueCount in class AddressDivision

getMaxValue

public long getMaxValue()

Overrides:

getMaxValue in class AddressDivision

isMultiple

public boolean isMultiple()

Description copied from interface: AddressItem

Whether this represents multiple potential values (eg a prefixed address or a segment representing a range of values)

Specified by:

isMultiple in interface AddressItem

Overrides:

isMultiple in class AddressDivision

Returns:

whether this segment represents multiple values

getSegmentValue

public int getSegmentValue()

returns the lower value

Specified by:

getSegmentValue in interface AddressSegment

getUpperSegmentValue

public int getUpperSegmentValue()

returns the upper value

Specified by:

getUpperSegmentValue in interface AddressSegment

getDivisionValue

public long getDivisionValue()

returns the lower value as a long, although for individual segments getSegmentValue() provides the same value as an int

Specified by:

getDivisionValue in class AddressDivision

getUpperDivisionValue

public long getUpperDivisionValue()

returns the lower upper value as a long, although for individual segments getUpperSegmentValue() provides the same value as an int

Specified by:

getUpperDivisionValue in class AddressDivision

reverseBits

public abstract IPAddressSegment 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 IncompatibleAddressException. 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

Specified by:

reverseBits in interface AddressSegment

Parameters:

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

Returns:

reverseBytes

public abstract IPAddressSegment 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 IncompatibleAddressException. 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

Specified by:

reverseBytes in interface AddressSegment

Returns:

removePrefixLength

public abstract IPAddressSegment removePrefixLength()

removePrefixLength

public abstract IPAddressSegment removePrefixLength(boolean zeroed)

withoutPrefixLength

public abstract IPAddressSegment withoutPrefixLength()

isBoundedBy

public boolean isBoundedBy(int value)

Description copied from class: AddressDivision

Returns true if the possible values of this division fall below the given value.

Specified by:

isBoundedBy in interface AddressStringDivision

Overrides:

isBoundedBy in class AddressDivision

getSegmentPrefixLength

public java.lang.Integer getSegmentPrefixLength()

hashCode

public int hashCode()

Overrides:

hashCode in class AddressDivision

prefixEquals

public boolean prefixEquals(IPAddressSegment other)

prefixEquals

public boolean prefixEquals(AddressSegment other,
                            int prefixLength)

Specified by:

prefixEquals in interface AddressSegment

includesZero

public boolean includesZero()

Specified by:

includesZero in interface AddressItem

Overrides:

includesZero in class AddressDivision

Returns:

whether this item includes the value of zero within its range

includesMax

public boolean includesMax()

Specified by:

includesMax in interface AddressItem

Overrides:

includesMax in class AddressDivision

Returns:

whether this item includes the maximum possible value within its range

toHexString

public java.lang.String toHexString(boolean with0xPrefix)

Description copied from interface: AddressComponent

Writes this address component as a single hexadecimal value with always the exact same number of characters, with or without a preceding 0x prefix.

If this component represents a range of values outside of the network prefix length, then this is printed as a range of two hex values.

For instance, for IPv4 addresses there are 8 hex characters, for IPv6 addresses there are 32 hex characters.

Specified by:

toHexString in interface AddressComponent

toNormalizedString

public java.lang.String toNormalizedString()

Description copied from interface: AddressComponent

Produces a string that is consistent for all address components of the same type and version.

Specified by:

toNormalizedString in interface AddressComponent

Returns:

toNormalizedString

public java.lang.String toNormalizedString(IPAddressSection.IPStringOptions options)