inet.ipaddr.ipv6

Class IPv6AddressSegment

java.lang.Object

inet.ipaddr.format.AddressDivisionBase

inet.ipaddr.format.AddressDivision

inet.ipaddr.format.IPAddressDivision

inet.ipaddr.IPAddressSegment

inet.ipaddr.ipv6.IPv6AddressSegment

All Implemented Interfaces:

AddressComponent, AddressSegment, AddressItem, AddressStringDivision, java.io.Serializable, java.lang.Comparable<AddressDivision>, java.lang.Iterable<IPv6AddressSegment>

public class IPv6AddressSegment
extends IPAddressSegment
implements java.lang.Iterable<IPv6AddressSegment>

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(AddressSegment other)
boolean	equals(java.lang.Object other)
int	getBitCount()
int	getByteCount() returns the number of bytes in each of the address components represented by this instance
int	getDefaultTextualRadix()
IPAddress.IPVersion	getIPVersion()
java.lang.Iterable<IPv6AddressSegment>	getIterable() Useful for using an instance in a "for-each loop".
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	getMaxDigitCount()
int	getMaxSegmentValue() Gets the maximum possible value for this type of segment (for the highest range value of this particular segment, use AddressSegment.getUpper()
<S extends AddressSegment> void	getSplitSegments(S[] segs, int index, AddressNetwork.AddressSegmentCreator<S> creator) Converts this IPv6 address segment into smaller segments, copying them into the given array starting at the given index.
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() 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.
static IPv6AddressSegment	join(IPv4AddressSegment one, IPv4AddressSegment two, int upperRangeLower, int upperRangeUpper, int lowerRangeLower, int lowerRangeUpper, java.lang.Integer segmentPrefixLength)
IPv6AddressSegment	removePrefixLength()
IPv6AddressSegment	removePrefixLength(boolean zeroed)
IPv6AddressSegment	reverseBits(boolean perByte) Returns a new AddressComponent with the bits reversed.
IPv6AddressSegment	reverseBytes() Returns an AddressComponent with the bytes reversed.
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, getDefaultTextualRadix, getDivisionValueCount, getLowerSegmentValue, getLowerValue, getMaxSegmentValue, getMaxValue, getMinPrefix, getSegmentPrefixLength, getUpperSegmentValue, getUpperValue, getValueCount, hashCode, isBoundedBy, isFullRange, isFullRange, isFullRange, isIPv4, isMaskCompatibleWithRange, isMaskCompatibleWithRange, isMultiple, matches, matchesWithMask, matchesWithPrefix, toHexString, toNormalizedString, toNormalizedString

Methods inherited from class inet.ipaddr.format.IPAddressDivision

getConfiguredString, getDivisionPrefixLength, getMaskPrefixLength, getString, getWildcardString, isBitwiseOrCompatibleWithRange, isMaskCompatibleWithRange, isPrefixed, isRangeEquivalent, isRangeEquivalentToPrefix, isRangeUnchanged, isSamePrefixedRange, matchesWithPrefix

Methods inherited from class inet.ipaddr.format.AddressDivision

compareTo, getCount, getDigitCount, getMaxDigitCount, hasUppercaseVariations, isZero, matches, matchesWithMask

Methods inherited from class inet.ipaddr.format.AddressDivisionBase

getBytes, getBytes, getDigitCount, getPrefixAdjustedString, getStandardString, getUpperBytes, getUpperBytes, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface inet.ipaddr.format.AddressItem

getBytes, getBytes, getCount, getUpperBytes, getUpperBytes, isZero

Methods inherited from interface java.lang.Comparable

compareTo

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()

Description copied from interface: AddressSegment

Gets the maximum possible value for this type of segment (for the highest range value of this particular segment, use AddressSegment.getUpper()

Specified by:

getMaxSegmentValue in interface AddressSegment

Returns:

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 AddressTypeException

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, then AddressTypeException is thrown. See IPAddress.applyPrefixLength(int), IPAddress#apply(IPAddress, Integer), IPAddress#isMaskCompatibleWithRange(IPAddress, Integer)

Specified by:

toMaskedSegment in class IPAddressSegment

Throws:

AddressTypeException

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 interface AddressComponent

Specified by:

getLower in interface AddressSegment

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 interface AddressComponent

Specified by:

getUpper in interface AddressSegment

Specified by:

getUpper in class IPAddressSegment

Returns:

reverseBits

public IPv6AddressSegment 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

Specified by:

reverseBits in interface AddressSegment

Specified by:

reverseBits in class IPAddressSegment

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 IPv6AddressSegment 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

Specified by:

reverseBytes in interface AddressSegment

Specified by:

reverseBytes in class IPAddressSegment

Returns:

removePrefixLength

public IPv6AddressSegment removePrefixLength(boolean zeroed)

Specified by:

removePrefixLength in class IPAddressSegment

removePrefixLength

public IPv6AddressSegment removePrefixLength()

Specified by:

removePrefixLength in class IPAddressSegment

getIterable

public java.lang.Iterable<IPv6AddressSegment> getIterable()

Description copied from interface: AddressComponent

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

Specified by:

getIterable in interface AddressComponent

Specified by:

getIterable in interface AddressSegment

Specified by:

getIterable in class IPAddressSegment

Returns:

iterator

public java.util.Iterator<IPv6AddressSegment> 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

Specified by:

iterator in interface AddressSegment

Specified by:

iterator in interface java.lang.Iterable<IPv6AddressSegment>

Specified by:

iterator in class IPAddressSegment

Returns:

getBitCount

public int getBitCount()

Specified by:

getBitCount in interface AddressItem

Returns:

the number of bits in this item

getByteCount

public int getByteCount()

Description copied from interface: AddressComponent

returns the number of bytes in each of the address components represented by this instance

Specified by:

getByteCount in interface AddressComponent

Returns:

getDefaultTextualRadix

public int getDefaultTextualRadix()

Specified by:

getDefaultTextualRadix in class AddressDivisionBase

Returns:

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

getMaxDigitCount

public int getMaxDigitCount()

Specified by:

getMaxDigitCount in class AddressDivisionBase

Returns:

the number of digits for the maximum possible value of the division when using the default radix

getSplitSegments

public <S extends AddressSegment> void getSplitSegments(S[] segs,
                                                        int index,
                                                        AddressNetwork.AddressSegmentCreator<S> creator)

Converts this IPv6 address segment into smaller 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 AddressTypeException

Throws:

AddressTypeException

contains

public boolean contains(AddressSegment other)

Specified by:

contains in interface AddressSegment

Overrides:

contains in class IPAddressSegment

Returns:

whether this subnet segment contains the given address segment

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface AddressSegment

Overrides:

equals in class java.lang.Object