Module inet.ipaddr

Package inet.ipaddr.format.large

Class IPAddressLargeDivision

java.lang.Object

inet.ipaddr.format.AddressDivisionBase

inet.ipaddr.format.large.IPAddressLargeDivision

All Implemented Interfaces:

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

public class IPAddressLargeDivision
extends AddressDivisionBase
implements IPAddressGenericDivision

This class supports a segment or division of an arbitrary number of bits.

For a bit count less than or equal to 63 bits, AddressDivision or IPAddressDivision is a more efficient choice, which are based on arithmetic using longs and can be grouped with AddressDivisionGrouping and IPAddressDivisionGrouping respectively.

Author:

sfoley

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static char	EXTENDED_DIGITS_RANGE_SEPARATOR
static java.lang.String	EXTENDED_DIGITS_RANGE_SEPARATOR_STR

Fields inherited from class inet.ipaddr.format.AddressDivisionBase

EXTENDED_DIGITS

Constructor Summary

Constructors

Constructor	Description
IPAddressLargeDivision(byte[] bytes, byte[] upperBytes, int bitCount, int defaultRadix, IPAddressNetwork<?,?,?,?,?> network, java.lang.Integer prefixLength)
IPAddressLargeDivision(byte[] bytes, int bitCount, int defaultRadix)
IPAddressLargeDivision(byte[] bytes, int bitCount, int defaultRadix, IPAddressNetwork<?,?,?,?,?> network, java.lang.Integer prefixLength)

Method Summary

Modifier and Type	Method	Description
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	getDefaultTextualRadix()
int	getDigitCount(int radix)	Returns the count of digits of the value, or if a range, the larger value in the range
java.lang.Integer	getDivisionPrefixLength()
int	getMaxDigitCount()
int	getMaxDigitCount(int radix)	Returns the count of digits of the largest possible value
int	getPrefixAdjustedRangeString(int segmentIndex, AddressSegmentParams params, java.lang.StringBuilder appendable)	Produces a string to represent the segment of the form a-b where the value b has been adjusted for the prefix, anything beyond the prefix length being zero.
java.lang.String	getString()	Produces a normalized string to represent the segment.
java.math.BigInteger	getUpperValue()	Returns the highest value represented by this address item, the highest value included in the range of values
java.math.BigInteger	getValue()	Returns the lowest value represented by this address item, the lowest value included in the range of values
java.lang.String	getWildcardString()	Produces a string to represent the segment, favouring wildcards and range characters over the network prefix to represent subnets.
boolean	includesMax()	Returns whether this item includes the maximum possible value for the address type or version within its range
boolean	includesZero()	Returns whether this item includes the value of zero within its range
boolean	isBoundedBy(int val)	Returns true if the possible values of this division fall below the given boundary value.
boolean	isMax()	Returns whether this item matches the maximum possible value for the address type or version
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
boolean	isPrefixed()
boolean	isSinglePrefixBlock()	Returns whether the division range matches the block of values for its prefix length
boolean	isZero()	Returns whether this item matches the value of zero

Methods inherited from class inet.ipaddr.format.AddressDivisionBase

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface inet.ipaddr.format.AddressItem

compareTo, containsPrefixBlock, containsSinglePrefixBlock, getByteCount, getBytes, getBytes, getBytes, getCount, getMinPrefixLengthForBlock, getPrefixCount, getPrefixLengthForSingleBlock, getUpperBytes, getUpperBytes, getUpperBytes

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

getLowerStandardString, getStandardString

Methods inherited from interface inet.ipaddr.format.IPAddressGenericDivision

isFullRange

Field Detail

EXTENDED_DIGITS_RANGE_SEPARATOR

public static final char EXTENDED_DIGITS_RANGE_SEPARATOR

See Also:

Constant Field Values

EXTENDED_DIGITS_RANGE_SEPARATOR_STR

public static final java.lang.String EXTENDED_DIGITS_RANGE_SEPARATOR_STR

Constructor Detail

IPAddressLargeDivision

public IPAddressLargeDivision(byte[] bytes,
                              int bitCount,
                              int defaultRadix)
                       throws AddressValueException

Throws:

AddressValueException

IPAddressLargeDivision

public IPAddressLargeDivision(byte[] bytes,
                              int bitCount,
                              int defaultRadix,
                              IPAddressNetwork<?,?,?,?,?> network,
                              java.lang.Integer prefixLength)
                       throws AddressValueException

Parameters:

bytes -

bitCount -

defaultRadix -

network - can be null if prefixLength is null

prefixLength -

Throws:

AddressValueException

IPAddressLargeDivision

public IPAddressLargeDivision(byte[] bytes,
                              byte[] upperBytes,
                              int bitCount,
                              int defaultRadix,
                              IPAddressNetwork<?,?,?,?,?> network,
                              java.lang.Integer prefixLength)
                       throws AddressValueException

Throws:

AddressValueException

Method Detail

getValue

public java.math.BigInteger getValue()

Description copied from interface: AddressItem

Returns the lowest value represented by this address item, the lowest value included in the range of values

Specified by:

getValue in interface AddressItem

Returns:

the lowest value represented by this address item

getUpperValue

public java.math.BigInteger getUpperValue()

Description copied from interface: AddressItem

Returns the highest value represented by this address item, the highest value included in the range of values

Specified by:

getUpperValue in interface AddressItem

Returns:

the highest value represented by this address item

isBoundedBy

public boolean isBoundedBy(int val)

Description copied from interface: AddressStringDivision

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

Specified by:

isBoundedBy in interface AddressStringDivision

getDigitCount

public int getDigitCount(int radix)

Description copied from interface: AddressStringDivision

Returns the count of digits of the value, or if a range, the larger value in the range

Specified by:

getDigitCount in interface AddressStringDivision

Returns:

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

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

includesZero

public boolean includesZero()

Description copied from interface: AddressItem

Returns whether this item includes the value of zero within its range

Specified by:

includesZero in interface AddressItem

Returns:

whether this item includes the value of zero within its range

includesMax

public boolean includesMax()

Description copied from interface: AddressItem

Returns whether this item includes the maximum possible value for the address type or version within its range

Specified by:

includesMax in interface AddressItem

Returns:

whether this item includes the maximum possible value within its range

isMax

public boolean isMax()

Description copied from interface: AddressItem

Returns whether this item matches the maximum possible value for the address type or version

Specified by:

isMax in interface AddressItem

Returns:

whether this item matches the maximum possible value

isZero

public boolean isZero()

Description copied from interface: AddressItem

Returns whether this item matches the value of zero

Specified by:

isZero in interface AddressItem

Returns:

whether this item matches the value of zero

getDefaultTextualRadix

public int getDefaultTextualRadix()

getMaxDigitCount

public int getMaxDigitCount()

getMaxDigitCount

public int getMaxDigitCount(int radix)

Description copied from interface: AddressStringDivision

Returns the count of digits of the largest possible value

Specified by:

getMaxDigitCount in interface AddressStringDivision

Returns:

getString

public java.lang.String getString()

Produces a normalized string to represent the segment. If the segment CIDR prefix length covers the range, then it is assumed to be a CIDR, and the string has only the lower value of the CIDR range. Otherwise, the explicit range will be printed.

Returns:

getWildcardString

public java.lang.String getWildcardString()

Produces a string to represent the segment, favouring wildcards and range characters over the network prefix to represent subnets. If it exists, the segment CIDR prefix is ignored and the explicit range is printed.

Returns:

getPrefixAdjustedRangeString

public int getPrefixAdjustedRangeString(int segmentIndex,
                                        AddressSegmentParams params,
                                        java.lang.StringBuilder appendable)

Description copied from interface: IPAddressStringDivision

Produces a string to represent the segment of the form a-b where the value b has been adjusted for the prefix, anything beyond the prefix length being zero.

Specified by:

getPrefixAdjustedRangeString in interface IPAddressStringDivision

Returns:

if the supplied appendable is null, returns the length of the string that would have been appended, otherwise returns 0

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

isSinglePrefixBlock

public boolean isSinglePrefixBlock()

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

Specified by:

isSinglePrefixBlock in interface IPAddressStringDivision

getDivisionPrefixLength

public java.lang.Integer getDivisionPrefixLength()

Specified by:

getDivisionPrefixLength in interface IPAddressStringDivision

isPrefixed

public boolean isPrefixed()

Specified by:

isPrefixed in interface IPAddressGenericDivision

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.

Overrides:

equals in class AddressDivisionBase