inet.ipaddr.ipv6

Class IPv6AddressSegment

java.lang.Object

inet.ipaddr.format.IPAddressDivision

inet.ipaddr.IPAddressSegment

inet.ipaddr.ipv6.IPv6AddressSegment

All Implemented Interfaces:

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

public class IPv6AddressSegment
extends IPAddressSegment

This represents a segment of an IP address. For IPv4, segments are 1 byte. For IPv6, they are two bytes. Like String and Integer and various others basic objects, segments are immutable, which also makes them thread-safe.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CHARS

Fields inherited from class inet.ipaddr.format.IPAddressDivision

ADJUST_RANGES_BY_PREFIX

Constructor Summary

Constructors

Constructor and Description
IPv6AddressSegment(int value) Constructs a segment of an IPv6 address with the given value.
IPv6AddressSegment(int value, java.lang.Integer segmentPrefixLength) Constructs a segment of an IPv6 address.
IPv6AddressSegment(int lower, int upper, java.lang.Integer segmentPrefixLength) Constructs a segment of an IPv6 address with the given range of values.

Method Summary

Modifier and Type	Method and Description
boolean	contains(IPAddressSegment other)
boolean	equals(java.lang.Object other)
int	getBitCount()
int	getByteCount()
int	getDefaultMaxChars()
int	getDefaultTextualRadix()
void	getIPv4Segments(IPv4AddressSegment[] segs, int index) Converts this IPv6 address segment into IPv4 segments, copying them into the given array starting at the given index.
IPAddress.IPVersion	getIPVersion()
IPv6AddressSegment	getLower() If this segment represents a range of values, returns a segment representing just the lowest value in the range, otherwise returns this.
int	getMaxSegmentValue()
IPv6AddressSegment	getUpper() If this segment represents a range of values, returns a segment representing just the highest value in the range, otherwise returns this.
boolean	isIPv6()
java.util.Iterator<IPv6AddressSegment>	iterator()
static IPv6AddressSegment	join(IPv4AddressSegment one, IPv4AddressSegment two, int upperRangeLower, int upperRangeUpper, int lowerRangeLower, int lowerRangeUpper, java.lang.Integer segmentPrefixLength)
IPv4AddressSegment[]	split() Splits this IPv6 address segment into one-byte segments
IPv6AddressSegment	toHostSegment(java.lang.Integer bits) used by getHostSection, see IPAddress.getHostSection(int)
IPv6AddressSegment	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.
IPv6AddressSegment	toNetworkSegment(java.lang.Integer segmentPrefixLength) used by constructors of IPAddressSection, see IPAddress.getNetworkSection(int, boolean)
IPv6AddressSegment	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.IPAddressSegment

getBitCount, getByteCount, getCount, getDefaultTextualRadix, getLowerSegmentValue, getLowerValue, getMaxSegmentValue, getMaxValue, getMinPrefix, getSegmentPrefixLength, getUpperSegmentValue, getUpperValue, hashCode, isFullRange, isFullRange, isIPv4, isMaskCompatibleWithRange, isMaskCompatibleWithRange, isMultiple, matches, matchesWithMask, matchesWithPrefix

Methods inherited from class inet.ipaddr.format.IPAddressDivision

compareTo, defaultMaxCharsPerSegment, getCharWidth, getDefaultMaxChars, 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

getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAX_CHARS

public static final int MAX_CHARS

See Also:

Constant Field Values

Constructor Detail

IPv6AddressSegment

public IPv6AddressSegment(int value)

Constructs a segment of an IPv6 address with the given value.

Parameters:

value - the value of the segment

IPv6AddressSegment

public IPv6AddressSegment(int value,
                          java.lang.Integer segmentPrefixLength)

Constructs a segment of an IPv6 address.

Parameters:

value - the value of the segment. If the segmentPrefixLength is non-null, the network prefix of the value is used, and the segment represents all segment values with the same network prefix.

segmentPrefixLength - the segment prefix length, which can be null

IPv6AddressSegment

public IPv6AddressSegment(int lower,
                          int upper,
                          java.lang.Integer segmentPrefixLength)

Constructs a segment of an IPv6 address with the given range of values.

Parameters:

segmentPrefixLength - the segment prefix length, which can be null. If segmentPrefixLength is non-null, this segment represents a range of segment values with the given network prefix length.

lower - the lower value of the range of values represented by the segment. If segmentPrefixLength is non-null, the lower value becomes the smallest value with the same network prefix.

upper - the upper value of the range of values represented by the segment. If segmentPrefixLength is non-null, the upper value becomes the largest value with the same network prefix.

Method Detail

isIPv6

public boolean isIPv6()

Overrides:

isIPv6 in class IPAddressSegment

getIPVersion

public IPAddress.IPVersion getIPVersion()

Specified by:

getIPVersion in class IPAddressSegment

getMaxSegmentValue

public int getMaxSegmentValue()

Specified by:

getMaxSegmentValue in class IPAddressSegment

toNetworkSegment

public IPv6AddressSegment toNetworkSegment(java.lang.Integer segmentPrefixLength)

Description copied from class: IPAddressSegment

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

Overrides:

toNetworkSegment in class IPAddressSegment

toNetworkSegment

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

Description copied from class: IPAddressSegment

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

Specified by:

toNetworkSegment in class IPAddressSegment

toHostSegment

public IPv6AddressSegment toHostSegment(java.lang.Integer bits)

Description copied from class: IPAddressSegment

used by getHostSection, see IPAddress.getHostSection(int)

Specified by:

toHostSegment in class IPAddressSegment

toMaskedSegment

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

Description copied from class: IPAddressSegment

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)

Specified by:

toMaskedSegment in class IPAddressSegment

Throws:

IPAddressTypeException

getLower

public IPv6AddressSegment getLower()

Description copied from class: IPAddressSegment

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 class IPAddressSegment

Returns:

getUpper

public IPv6AddressSegment getUpper()

Description copied from class: IPAddressSegment

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 class IPAddressSegment

Returns:

iterator

public java.util.Iterator<IPv6AddressSegment> iterator()

Specified by:

iterator in class IPAddressSegment

getBitCount

public int getBitCount()

Specified by:

getBitCount in class IPAddressDivision

getByteCount

public int getByteCount()

Specified by:

getByteCount in class IPAddressDivision

getDefaultTextualRadix

public int getDefaultTextualRadix()

Specified by:

getDefaultTextualRadix in class IPAddressDivision

Returns:

the default radix for textual representations of addresses (10 for IPv4, 16 for IPv6)

getDefaultMaxChars

public int getDefaultMaxChars()

Specified by:

getDefaultMaxChars in class IPAddressDivision

Returns:

the max number of characters per segment when using the default radix

getIPv4Segments

public void getIPv4Segments(IPv4AddressSegment[] segs,
                            int index)

Converts this IPv6 address segment into IPv4 segments, copying them into the given array starting at the given index. If a segment does not fit into the array because the segment index in the array is out of bounds of the array, then it is not copied.

Parameters:

segs -

index -

split

public IPv4AddressSegment[] split()

Splits this IPv6 address segment into one-byte segments

Returns:

join

public static IPv6AddressSegment join(IPv4AddressSegment one,
                                      IPv4AddressSegment two,
                                      int upperRangeLower,
                                      int upperRangeUpper,
                                      int lowerRangeLower,
                                      int lowerRangeUpper,
                                      java.lang.Integer segmentPrefixLength)
                               throws IPAddressTypeException

Throws:

IPAddressTypeException

contains

public boolean contains(IPAddressSegment other)

Overrides:

contains in class IPAddressSegment

Returns:

whether this subnet segment contains the given address segment

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object