inet.ipaddr.format

Class AddressDivisionGrouping

java.lang.Object

inet.ipaddr.format.AddressDivisionGrouping

All Implemented Interfaces:

AddressDivisionSeries, AddressItem, AddressStringDivisionSeries, java.io.Serializable, java.lang.Comparable<AddressDivisionGrouping>

Direct Known Subclasses:

IPAddressDivisionGrouping, MACAddressSection

public class AddressDivisionGrouping
extends java.lang.Object
implements AddressDivisionSeries, java.lang.Comparable<AddressDivisionGrouping>

AddressDivisionGrouping objects consist of a series of AddressDivision objects, each division containing one or more segments.

AddressDivisionGrouping objects are immutable. This also makes them thread-safe.

AddressDivision objects use long to represent their values, so this places a cap on the size of the divisions in AddressDivisionGrouping.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddressDivisionGrouping.StringOptions Represents a clear way to create a specific type of string.

Constructor Summary

Constructors

Constructor and Description
AddressDivisionGrouping(AddressDivision[] divisions)
AddressDivisionGrouping(AddressDivision[] divisions, boolean checkDivisions)

Method Summary

Modifier and Type	Method and Description
int	compareTo(AddressDivisionGrouping other)
boolean	containsPrefixBlock(int prefixLength) Returns whether the values of this division grouping contain the prefix block for the given prefix length
boolean	containsSinglePrefixBlock(int prefixLength) Returns whether the values of this division grouping match the prefix block for the given prefix length
boolean	equals(java.lang.Object o)
int	getBitCount()
byte[]	getBytes() Gets the bytes for the lowest address in the range represented by this address.
byte[]	getBytes(byte[] bytes) Equivalent to getBytes(byte[], int) with index of 0.
byte[]	getBytes(byte[] bytes, int index) Gets the value for the lowest address in the range represented by this address division.
java.math.BigInteger	getCount() gets the count of addresses that this address may represent If this address division grouping is not a subnet block of multiple addresses or has no range of values, then there is only one such address.
AddressDivision	getDivision(int index)
int	getDivisionCount()
java.lang.String[]	getDivisionStrings() Get standard-format strings for each of the divisions in the series.
int	getMinPrefixLengthForBlock() Returns the smallest prefix length possible such that this address division grouping includes the block of addresses for that prefix.
java.math.BigInteger	getPrefixCount() If this has a prefix length, the count of the range of values in the prefix.
java.lang.Integer	getPrefixLength() The bit-length of the portion of the address that is not specific to an individual address but common amongst a group of addresses.
java.lang.Integer	getPrefixLengthForSingleBlock() Returns a prefix length for which the range of this segment grouping matches the the block of addresses for that prefix.
byte[]	getUpperBytes() Gets the bytes for the highest address in the range represented by this address.
byte[]	getUpperBytes(byte[] bytes) Equivalent to getBytes(byte[], int) with index of 0.
byte[]	getUpperBytes(byte[] bytes, int index) Similar to getBytes(byte[], int), but for obtaining the upper value of the range.
java.math.BigInteger	getUpperValue()
java.math.BigInteger	getValue()
int	hashCode()
boolean	includesMax()
boolean	includesZero()
boolean	isFullRange()
boolean	isMax()
int	isMore(AddressDivisionSeries other) Use this method to compare the counts of two address series.
boolean	isMultiple() Whether this represents multiple potential values (eg a prefixed address or a segment representing a range of values)
boolean	isPrefixBlock() Returns whether this address segment series represents a block of addresses associated with its prefix length.
boolean	isPrefixed() Whether there exists a prefix.
boolean	isSinglePrefixBlock() Returns whether the range of values matches a single subnet block for the prefix length
boolean	isZero()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AddressDivisionGrouping

public AddressDivisionGrouping(AddressDivision[] divisions)

AddressDivisionGrouping

public AddressDivisionGrouping(AddressDivision[] divisions,
                               boolean checkDivisions)

Method Detail

getDivision

public AddressDivision getDivision(int index)

Specified by:

getDivision in interface AddressDivisionSeries

Specified by:

getDivision in interface AddressStringDivisionSeries

Returns:

the given division in this series. The first is at index 0.

getDivisionCount

public int getDivisionCount()

Specified by:

getDivisionCount in interface AddressStringDivisionSeries

getBitCount

public int getBitCount()

Specified by:

getBitCount in interface AddressItem

Returns:

the number of bits comprising this address item

getBytes

public byte[] getBytes()

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

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,
                       int index)

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

getBytes

public byte[] getBytes(byte[] bytes)

Equivalent to getBytes(byte[], int) with index of 0.

Specified by:

getBytes in interface AddressItem

Returns:

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

getUpperBytes

public byte[] getUpperBytes()

Gets the bytes for the highest address in the range represented by this address.

Specified by:

getUpperBytes in interface AddressItem

Returns:

getUpperBytes

public byte[] getUpperBytes(byte[] bytes,
                            int index)

Similar to getBytes(byte[], int), but for obtaining the upper value of the range. If this division represents a single value, equivalent to getBytes(byte[], int)

Specified by:

getUpperBytes in interface AddressItem

Returns:

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

getUpperBytes

public byte[] getUpperBytes(byte[] bytes)

Equivalent to getBytes(byte[], int) with index of 0.

Specified by:

getUpperBytes in interface AddressItem

Returns:

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

getValue

public java.math.BigInteger getValue()

Specified by:

getValue in interface AddressDivisionSeries

Returns:

the value of the lowest address item represented by this address division series

getUpperValue

public java.math.BigInteger getUpperValue()

Specified by:

getUpperValue in interface AddressDivisionSeries

Returns:

the value of the highest address item represented by this address division series

isPrefixed

public boolean isPrefixed()

Description copied from interface: AddressDivisionSeries

Whether there exists a prefix.

Specified by:

isPrefixed in interface AddressDivisionSeries

getPrefixLength

public java.lang.Integer getPrefixLength()

Description copied from interface: AddressDivisionSeries

The bit-length of the portion of the address that is not specific to an individual address but common amongst a group of addresses.

Typically this is the largest number of bits in the upper-most portion of the section for which the remaining bits assume all possible values.

For IP addresses, this must be explicitly defined when the address is created. For example, 1.2.0.0/16 has a prefix length of 16, while 1.2.*.* has no prefix length, even though they both represent the same set of addresses and are considered equal. Prefixes can be considered variable for any given IP addresses and can depend on the routing table.

The methods AddressDivisionSeries.getMinPrefixLengthForBlock() and AddressDivisionSeries.getPrefixLengthForSingleBlock() can help you to obtain or define a prefix length if one does not exist already. 1.2.0.0/16 and 1.2.*.* both the same equivalent and minimum prefix length of 16.

For MAC addresses, the prefix is initially defined by the range, so 1:2:3:*:*:* has a prefix length of 24 by definition. Addresses derived from the original may retain the original prefix length regardless of their range.

Specified by:

getPrefixLength in interface AddressDivisionSeries

getMinPrefixLengthForBlock

public int getMinPrefixLengthForBlock()

Returns the smallest prefix length possible such that this address division grouping includes the block of addresses for that prefix.

Specified by:

getMinPrefixLengthForBlock in interface AddressDivisionSeries

Returns:

the prefix length

getPrefixLengthForSingleBlock

public java.lang.Integer getPrefixLengthForSingleBlock()

Returns a prefix length for which the range of this segment grouping matches the the block of addresses for that prefix. If no such prefix exists, returns null If this segment grouping represents a single value, returns the bit length

Specified by:

getPrefixLengthForSingleBlock in interface AddressDivisionSeries

Returns:

the prefix length or null

getCount

public java.math.BigInteger getCount()

gets the count of addresses that this address may represent If this address division grouping is not a subnet block of multiple addresses or has no range of values, then there is only one such address.

Specified by:

getCount in interface AddressItem

Returns:

getPrefixCount

public java.math.BigInteger getPrefixCount()

Description copied from interface: AddressDivisionSeries

If this has a prefix length, the count of the range of values in the prefix.

If this has no prefix length, returns the same value as AddressItem.getCount()

Specified by:

getPrefixCount in interface AddressDivisionSeries

Returns:

isMore

public int isMore(AddressDivisionSeries other)

Description copied from interface: AddressDivisionSeries

Use this method to compare the counts of two address series. Rather than calculating counts with getCount(), there can be more efficient ways of comparing whether one series represents more individual address series than another.

Specified by:

isMore in interface AddressDivisionSeries

Returns:

a positive integer if this AddressDivisionSeries has a larger count than the provided, 0 if they are the same, a negative integer if the other has a larger count.

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

Returns:

whether this address represents more than one address. Such addresses include CIDR/IP addresses (eg 1.2.3.4/11) or wildcard addresses (eg 1.2.*.4) or range addresses (eg 1.2.3-4.5)

isSinglePrefixBlock

public boolean isSinglePrefixBlock()

Description copied from interface: AddressDivisionSeries

Returns whether the range of values matches a single subnet block for the prefix length

Specified by:

isSinglePrefixBlock in interface AddressDivisionSeries

Returns:

isPrefixBlock

public boolean isPrefixBlock()

Description copied from interface: AddressDivisionSeries

Returns whether this address segment series represents a block of addresses associated with its prefix length.

This returns false if it has no prefix length or if it is a range of addresses that does not include the entire subnet block for the prefix length.

If AddressNetwork.getPrefixConfiguration() is set to consider all prefixes as subnets, this returns true for any series with a prefix length.

Specified by:

isPrefixBlock in interface AddressDivisionSeries

Returns:

containsPrefixBlock

public boolean containsPrefixBlock(int prefixLength)

Returns whether the values of this division grouping contain the prefix block for the given prefix length

Specified by:

containsPrefixBlock in interface AddressDivisionSeries

Parameters:

prefixLength -

Returns:

containsSinglePrefixBlock

public boolean containsSinglePrefixBlock(int prefixLength)

Returns whether the values of this division grouping match the prefix block for the given prefix length

Specified by:

containsSinglePrefixBlock in interface AddressDivisionSeries

Parameters:

prefixLength -

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(AddressDivisionGrouping other)

Specified by:

compareTo in interface java.lang.Comparable<AddressDivisionGrouping>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDivisionStrings

public java.lang.String[] getDivisionStrings()

Description copied from interface: AddressDivisionSeries

Get standard-format strings for each of the divisions in the series.

Specified by:

getDivisionStrings in interface AddressDivisionSeries

Returns:

isZero

public boolean isZero()

Specified by:

isZero in interface AddressItem

Returns:

whether this item matches the value of zero

includesZero

public boolean includesZero()

Specified by:

includesZero in interface AddressItem

Returns:

whether this item includes the value of zero within its range

isMax

public boolean isMax()

Specified by:

isMax in interface AddressItem

Returns:

whether this item matches the maximum possible value

includesMax

public boolean includesMax()

Specified by:

includesMax in interface AddressItem

Returns:

whether this item includes the maximum possible value within its range

isFullRange

public boolean isFullRange()

Specified by:

isFullRange in interface AddressItem

Returns:

whether this address item represents all possible values attainable by an address item of this type, or in other words, both includesZero() and includesMax() return true