inet.ipaddr.format

Class AddressDivisionBase

java.lang.Object

inet.ipaddr.format.AddressDivisionBase

All Implemented Interfaces:

AddressItem, AddressStringDivision, java.io.Serializable

Direct Known Subclasses:

AddressDivision, IPAddressLargeDivision

public abstract class AddressDivisionBase
extends java.lang.Object
implements AddressItem, AddressStringDivision

Base class for address divisions.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Gets the bytes for the lowest address in the range represented by this address division.
byte[]	getBytes(byte[] bytes) Gets the value for the lowest address in the range represented by this address division.
abstract int	getDefaultTextualRadix()
static int	getDigitCount(long value, int radix)
int	getLowerStandardString(int segmentIndex, AddressSegmentParams params, java.lang.StringBuilder appendable) Configures a segment string according to the given params and the given segment index, but using only the lower value of the segment range, if there is a range.
abstract int	getMaxDigitCount()
int	getStandardString(int segmentIndex, AddressSegmentParams params, java.lang.StringBuilder appendable) Produces a string to represent the segment, using wildcards and range characters.
java.lang.String	getString() Produces a normalized string to represent the segment.
byte[]	getUpperBytes()
byte[]	getUpperBytes(byte[] bytes) Copies the bytes of the largest address item represented by this address item into the supplied array, and returns that array.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface inet.ipaddr.format.AddressItem

getBitCount, getCount, includesMax, includesZero, isFullRange, isMax, isMultiple, isZero

Methods inherited from interface inet.ipaddr.format.AddressStringDivision

getDigitCount, getMaxDigitCount, isBoundedBy

Method Detail

getBytes

public byte[] getBytes()

Gets the bytes for the lowest address in the range represented by this address division.

Since bytes are signed values while addresses are unsigned, values greater than 127 are represented as the (negative) two's complement value of the actual value. You can get the unsigned integer value i from byte b using i = 0xff & b.

Specified by:

getBytes in interface AddressItem

Returns:

getBytes

public byte[] getBytes(byte[] bytes)

Gets the value for the lowest address in the range represented by this address division.

If the value fits in the specified array, the same array is returned with the value. Otherwise, a new array is allocated and returned with the value.

You can use AddressItem.getBitCount() to determine the required array length for the bytes.

Since bytes are signed values while addresses are unsigned, values greater than 127 are represented as the (negative) two's complement value of the actual value. You can get the unsigned integer value i from byte b using i = 0xff & b.

Specified by:

getBytes in interface AddressItem

Returns:

getUpperBytes

public byte[] getUpperBytes()

Specified by:

getUpperBytes in interface AddressItem

Returns:

the bytes of the largest address item represented by this address item

getUpperBytes

public byte[] getUpperBytes(byte[] bytes)

Description copied from interface: AddressItem

Copies the bytes of the largest address item represented by this address item into the supplied array, and returns that array. If the supplied array is null or of insufficient size, a new array is created and returned.

Specified by:

getUpperBytes in interface AddressItem

Returns:

the bytes of the largest address represented by this address item.

getDefaultTextualRadix

public abstract int getDefaultTextualRadix()

Returns:

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

getMaxDigitCount

public abstract int getMaxDigitCount()

Returns:

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

getDigitCount

public static int getDigitCount(long value,
                                int radix)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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:

getLowerStandardString

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

Description copied from interface: AddressStringDivision

Configures a segment string according to the given params and the given segment index, but using only the lower value of the segment range, if there is a range.

If appendable is null, simply returns the length of the string that would have been appended.

Specified by:

getLowerStandardString in interface AddressStringDivision

Returns:

getStandardString

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

Produces a string to represent the segment, using wildcards and range characters. Use this instead of getWildcardString() if you have a customized wildcard or range separator or you have a non-zero leadingZeroCount, or you have a non-standard radix (for IPv4 standard radix is 10, for IPv6 it is 16)

Specified by:

getStandardString in interface AddressStringDivision

Returns: