inet.ipaddr

Class IPAddressSegment

java.lang.Object

inet.ipaddr.format.IPAddressDivision

inet.ipaddr.IPAddressSegment

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IPAddressDivision>

Direct Known Subclasses:

IPv4AddressSegment, IPv6AddressSegment

public abstract class IPAddressSegment
extends IPAddressDivision

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

Field Summary

Fields inherited from class inet.ipaddr.format.IPAddressDivision

ADJUST_RANGES_BY_PREFIX

Method Summary

Modifier and Type	Method and Description
boolean	contains(IPAddressSegment other)
static int	getBitCount(IPAddress.IPVersion version)
static int	getByteCount(IPAddress.IPVersion version)
long	getCount()
static int	getDefaultTextualRadix(IPAddress.IPVersion version)
abstract IPAddress.IPVersion	getIPVersion()
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.
int	getLowerSegmentValue() returns the lower value
long	getLowerValue() returns the lower value as a long, although for individual segments getLowerSegmentValue() provides the same value as an int
abstract int	getMaxSegmentValue()
static int	getMaxSegmentValue(IPAddress.IPVersion version)
long	getMaxValue()
int	getMinPrefix()
java.lang.Integer	getSegmentPrefixLength()
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.
int	getUpperSegmentValue() returns the upper value
long	getUpperValue() returns the lower upper value as a long, although for individual segments getUpperSegmentValue() provides the same value as an int
int	hashCode()
static boolean	isFullRange(int lower, int upper, java.lang.Integer prefix, IPAddress.IPVersion version)
static boolean	isFullRange(int lower, int upper, IPAddress.IPVersion version)
boolean	isIPv4()
boolean	isIPv6()
boolean	isMaskCompatibleWithRange(int maskValue, java.lang.Integer segmentPrefix)
boolean	isMaskCompatibleWithRange(IPAddressSegment maskSegment, java.lang.Integer segmentPrefixLength)
boolean	isMultiple()
abstract java.util.Iterator<? extends IPAddressSegment>	iterator()
boolean	matches(int value)
boolean	matchesWithMask(int value, int mask)
boolean	matchesWithPrefix(int value, java.lang.Integer segmentPrefixLength)
abstract IPAddressSegment	toHostSegment(java.lang.Integer segmentPrefixLength) used by getHostSection, see IPAddress.getHostSection(int)
abstract IPAddressSegment	toMaskedSegment(IPAddressSegment maskSegment, java.lang.Integer segmentPrefixLength) returns a new segment masked by the given mask This method applies the mask first to every address in the range, and it does not preserve any existing prefix.
IPAddressSegment	toNetworkSegment(java.lang.Integer segmentPrefixLength) used by constructors of IPAddressSection, see IPAddress.getNetworkSection(int, boolean)
abstract IPAddressSegment	toNetworkSegment(java.lang.Integer segmentPrefixLength, boolean withPrefixLength) used by getNetworkSection and by constructors of IPAddressSection, see IPAddress.getNetworkSection(int, boolean)

Methods inherited from class inet.ipaddr.format.IPAddressDivision

compareTo, defaultMaxCharsPerSegment, getBitCount, getByteCount, getCharWidth, getDefaultMaxChars, getDefaultMaxChars, getDefaultTextualRadix, getDivisionPrefixLength, getMaskPrefixLength, getMaxLeadingZeros, getPrefixAdjustedWildcardString, getString, getWildcardString, getWildcardString, hasAlphabeticDigits, isFullRange, isMaskCompatibleWithRange, isPrefixed, isRangeEquivalent, isRangeEquivalentToPrefix, isRangeUnchanged, isSamePrefixedRange, isZero, matches, matchesWithMask, matchesWithPrefix, rangeIsWithin, toString, valueIsWithin

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Method Detail

isIPv4

public boolean isIPv4()

isIPv6

public boolean isIPv6()

getIPVersion

public abstract IPAddress.IPVersion getIPVersion()

getMinPrefix

public int getMinPrefix()

getMaxSegmentValue

public static int getMaxSegmentValue(IPAddress.IPVersion version)

toNetworkSegment

public IPAddressSegment toNetworkSegment(java.lang.Integer segmentPrefixLength)

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

toNetworkSegment

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

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

toHostSegment

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

used by getHostSection, see IPAddress.getHostSection(int)

toMaskedSegment

public abstract IPAddressSegment toMaskedSegment(IPAddressSegment maskSegment,
                                                 java.lang.Integer segmentPrefixLength)
                                          throws IPAddressTypeException

returns a new segment masked by the given mask This method applies the mask first to every address in the range, and it does not preserve any existing prefix. The given prefix will be applied to the range of addresses after the mask. If the combination of the two does not result in a contiguous range of addresses, then IPAddressTypeException is thrown. See IPAddress.toSubnet(int), IPAddress.toSubnet(IPAddress, Integer), IPAddress.isMaskCompatibleWithRange(IPAddress, Integer)

Throws:

IPAddressTypeException

isMaskCompatibleWithRange

public boolean isMaskCompatibleWithRange(IPAddressSegment maskSegment,
                                         java.lang.Integer segmentPrefixLength)

isMaskCompatibleWithRange

public boolean isMaskCompatibleWithRange(int maskValue,
                                         java.lang.Integer segmentPrefix)

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.

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.

Returns:

iterator

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

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)

matchesWithPrefix

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

matchesWithMask

public boolean matchesWithMask(int value,
                               int mask)

getCount

public long getCount()

Overrides:

getCount in class IPAddressDivision

getMaxValue

public long getMaxValue()

getMaxSegmentValue

public abstract int getMaxSegmentValue()

isMultiple

public boolean isMultiple()

Overrides:

isMultiple in class IPAddressDivision

Returns:

whether this segment represents multiple values

getLowerSegmentValue

public int getLowerSegmentValue()

returns the lower value

getUpperSegmentValue

public int getUpperSegmentValue()

returns the upper value

getLowerValue

public long getLowerValue()

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

Specified by:

getLowerValue in class IPAddressDivision

getUpperValue

public long getUpperValue()

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

Specified by:

getUpperValue in class IPAddressDivision

getSegmentPrefixLength

public java.lang.Integer getSegmentPrefixLength()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

contains

public boolean contains(IPAddressSegment other)

Parameters:

other -

Returns:

whether this subnet segment contains the given address segment

isFullRange

public static boolean isFullRange(int lower,
                                  int upper,
                                  java.lang.Integer prefix,
                                  IPAddress.IPVersion version)

isFullRange

public static boolean isFullRange(int lower,
                                  int upper,
                                  IPAddress.IPVersion version)