inet.ipaddr.format.standard

Class AddressDivisionGrouping

java.lang.Object

inet.ipaddr.format.AddressDivisionGroupingBase

inet.ipaddr.format.standard.AddressDivisionGrouping

All Implemented Interfaces:

AddressDivisionSeries, AddressItem, AddressStringDivisionSeries, Serializable, Comparable<AddressItem>

Direct Known Subclasses:

IPAddressDivisionGrouping, MACAddressSection

public class AddressDivisionGrouping
extends AddressDivisionGroupingBase

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 interface	AddressDivisionGrouping.DivisionLengthProvider
static interface	AddressDivisionGrouping.DivisionValueProvider
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
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(Object o) Two groupings are equal if: - they match type/version (ipv4, ipv6, mac, or a specific grouping class) - they match division counts - each division matches bit counts - each division matches their specific grouping class - each division matches values Prefix lengths, for those groupings and/or divisionsS that have them, are ignored.
AddressDivision	getDivision(int index)
int	hashCode() Returns a hash code value for the object.

Methods inherited from class inet.ipaddr.format.AddressDivisionGroupingBase

getBytes, getBytes, getBytes, getCount, getDivisionCount, getDivisionStrings, getMinPrefixLengthForBlock, getPrefixCount, getPrefixLength, getPrefixLengthForSingleBlock, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isPrefixBlock, isPrefixed, isSinglePrefixBlock, isZero, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface inet.ipaddr.format.AddressDivisionSeries

getBitCount, getBlockCount, getPrefixCount, getSequentialBlockIndex, isMore, isSequential

Methods inherited from interface inet.ipaddr.format.AddressItem

compareTo, getByteCount

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

Overrides:

getDivision in class AddressDivisionGroupingBase

Returns:

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

containsPrefixBlock

public boolean containsPrefixBlock(int prefixLength)

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

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

Parameters:

prefixLength -

Returns:

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Overrides:

hashCode in class AddressDivisionGroupingBase

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public boolean equals(Object o)

Description copied from class: AddressDivisionGroupingBase

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

Overrides:

equals in class AddressDivisionGroupingBase

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap