inet.ipaddr.ipv6

Class IPv6AddressSegment

java.lang.Object

inet.ipaddr.format.AddressDivisionBase

inet.ipaddr.format.standard.AddressDivision

inet.ipaddr.format.standard.IPAddressDivision

inet.ipaddr.IPAddressSegment

inet.ipaddr.ipv6.IPv6AddressSegment

All Implemented Interfaces:

AddressComponent, AddressSegment, AddressGenericDivision, AddressItem, AddressItemRange, IPAddressGenericDivision, AddressStringDivision, IPAddressStringDivision, java.io.Serializable, java.lang.Comparable<AddressItem>, 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

Nested Class Summary

Nested classes/interfaces inherited from class inet.ipaddr.format.standard.AddressDivision

AddressDivision.BitwiseOrResult, AddressDivision.MaskResult

Field Summary

Fields

Modifier and Type	Field and Description
static int	BITS_PER_CHAR
static int	MAX_CHARS

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) Two divisions are equal if they: - they match type/version (ipv4, ipv6, mac, or a specific division class) - match bit counts - match values Prefix lengths, for those divisions that have them, are ignored.
int	getBitCount() Provides the number of bits comprising this address item
int	getByteCount() Provides the number of bytes required for this address item, rounding up if the bit count is not a multiple of 8
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()
long	getMaxValue()
IPv6AddressNetwork	getNetwork()
<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() Iterates through the individual elements of this address component.
java.util.Iterator<IPv6AddressSegment>	prefixBlockIterator() Iterates through the individual prefix blocks.
java.util.Iterator<IPv6AddressSegment>	prefixBlockIterator(int prefixLength) Iterates through the individual prefix blocks according to the given segment prefix length.
boolean	prefixEquals(AddressSegment other, int segmentPrefixLength)
boolean	prefixEquals(IPAddressSegment other)
java.util.Iterator<IPv6AddressSegment>	prefixIterator() Iterates through the individual prefixes.
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.
IPv6AddressSegment	toHostSegment(java.lang.Integer bits) used by getHostSection, see IPAddressSegmentSeries.getHostSection(int)
IPv6AddressSegment	toNetworkSegment(java.lang.Integer segmentPrefixLength) used by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)
IPv6AddressSegment	toNetworkSegment(java.lang.Integer segmentPrefixLength, boolean withPrefixLength) used by getNetworkSection and by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)
IPv6AddressSegment	withoutPrefixLength()

Methods inherited from class inet.ipaddr.IPAddressSegment

bitwiseOrRange, getBitCount, getByteCount, getDefaultTextualRadix, getDivisionValue, getDivisionValueCount, getMaxSegmentValue, getMinPrefixLengthForBlock, getPrefixValueCount, getSegmentPrefixLength, getSegmentValue, getUpperDivisionValue, getUpperSegmentValue, getValueCount, hashCode, includesMax, includesZero, isBoundedBy, isIPv4, isMultiple, isPrefixBlock, maskRange, matches, matchesWithMask, matchesWithMask, matchesWithPrefixMask, toHexString, toNormalizedString, toNormalizedString

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

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

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

bitwiseOrRange, getCount, getDigitCount, getDivisionPrefixCount, getMaxDigitCount, getPrefixCount, getPrefixLengthForSingleBlock, getUpperValue, getValue, hasUppercaseVariations, isBitwiseOrCompatibleWithRange, isMaskCompatibleWithRange, isMax, isZero, maskRange, 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 java.lang.Iterable

forEach, spliterator

Methods inherited from interface inet.ipaddr.format.AddressItem

compareTo, containsPrefixBlock, containsSinglePrefixBlock, 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

Field Detail

MAX_CHARS

public static final int MAX_CHARS

See Also:

Constant Field Values

BITS_PER_CHAR

public static final int BITS_PER_CHAR

See Also:

Constant Field Values

Constructor Detail

IPv6AddressSegment

public IPv6AddressSegment(int value)
                   throws AddressValueException

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

Parameters:

value - the value of the segment

Throws:

AddressValueException - if value is negative or too large

IPv6AddressSegment

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

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

Throws:

AddressValueException - if value or prefix length is negative or too large

IPv6AddressSegment

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

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.

Throws:

AddressValueException - if value or prefix length is negative or too large

Method Detail

getMaxValue

public long getMaxValue()

Overrides:

getMaxValue in class IPAddressSegment

isIPv6

public boolean isIPv6()

Overrides:

isIPv6 in class IPAddressSegment

getIPVersion

public IPAddress.IPVersion getIPVersion()

Specified by:

getIPVersion in class IPAddressSegment

getNetwork

public IPv6AddressNetwork getNetwork()

Specified by:

getNetwork in interface AddressSegment

Specified by:

getNetwork 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 IPAddressSegmentSeries.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 IPAddressSegmentSeries.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 IPAddressSegmentSeries.getHostSection(int)

Specified by:

toHostSegment in class IPAddressSegment

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

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

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

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

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

withoutPrefixLength

public IPv6AddressSegment withoutPrefixLength()

Specified by:

withoutPrefixLength in class IPAddressSegment

getIterable

public java.lang.Iterable<IPv6AddressSegment> 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

Specified by:

getIterable in class IPAddressSegment

Returns:

iterator

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

Specified by:

iterator in interface java.lang.Iterable<IPv6AddressSegment>

Specified by:

iterator in class IPAddressSegment

Returns:

prefixBlockIterator

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

Description copied from class: IPAddressSegment

Iterates through the individual prefix blocks.

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

Specified by:

prefixBlockIterator in class IPAddressSegment

prefixBlockIterator

public java.util.Iterator<IPv6AddressSegment> prefixBlockIterator(int prefixLength)

Description copied from class: IPAddressSegment

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

Specified by:

prefixBlockIterator in class IPAddressSegment

prefixIterator

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

Description copied from class: IPAddressSegment

Iterates through the individual prefixes.

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

Specified by:

prefixIterator in class IPAddressSegment

getBitCount

public int getBitCount()

Description copied from interface: AddressItem

Provides the number of bits comprising this address item

Specified by:

getBitCount in interface AddressItem

Specified by:

getBitCount in interface IPAddressStringDivision

Returns:

the number of bits

getByteCount

public int getByteCount()

Description copied from interface: AddressItem

Provides the number of bytes required for this address item, rounding up if the bit count is not a multiple of 8

Specified by:

getByteCount in interface AddressItem

Returns:

the number of bytes

getDefaultTextualRadix

public int getDefaultTextualRadix()

Returns:

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

getMaxDigitCount

public int getMaxDigitCount()

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 -

prefixEquals

public boolean prefixEquals(IPAddressSegment other)

Overrides:

prefixEquals in class IPAddressSegment

prefixEquals

public boolean prefixEquals(AddressSegment other,
                            int segmentPrefixLength)

Specified by:

prefixEquals in interface AddressSegment

Overrides:

prefixEquals in class IPAddressSegment

contains

public boolean contains(AddressSegment other)

Specified by:

contains in interface AddressSegment

equals

public boolean equals(java.lang.Object other)

Description copied from class: AddressDivisionBase

Two divisions are equal if they: - they match type/version (ipv4, ipv6, mac, or a specific division class) - match bit counts - match values Prefix lengths, for those divisions that have them, are ignored.

Specified by:

equals in interface AddressSegment

Overrides:

equals in class AddressDivision