AddressItem

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

AddressComponent, AddressDivisionSeries, AddressSection, AddressSegment, AddressSegmentSeries, IPAddressSegmentSeries

All Known Implementing Classes:

Address, AddressBitsDivision, AddressDivision, AddressDivisionBase, AddressDivisionGrouping, IPAddress, IPAddressBitsDivision, IPAddressDivision, IPAddressDivisionGrouping, IPAddressJoinedSegments, IPAddressLargeDivision, IPAddressSection, IPAddressSegment, IPv4Address, IPv4AddressSection, IPv4AddressSegment, IPv4JoinedSegments, IPv6Address, IPv6AddressSection, IPv6AddressSection.IPv6v4MixedAddressSection, IPv6AddressSegment, MACAddress, MACAddressSection, MACAddressSegment
```
public interface AddressItem
extends java.io.Serializable
```
Represents any part of an address, whether divided into the standard arrangement of AddressComponent objects, or whether an alternative arrangement using AddressDivision objects.
The basic difference between the AddressComponent hierarchy and the AddressDivision hierarchy is that
AddressComponent hierarchy uses
- standardized/typical arrangement (ie for ipv4, 4 equal segments of 1 byte each, for ipv6, 8 equal segments of 2 bytes each, for mac, 6 or 8 equal segments of 1 byte each)
- equal size segments
- segments divided along byte boundaries
AddressDivision allows alternative arrangements, such as inet_aton style of presenting ipv4 in fewer divisions, or base 85 for ipv6 which does not even use a base that is a power of 2 (and hence so subdivisions possibly using bit boundaries), or the aaa-bbb-ccc-ddd mac format with which segments are not divided along byte boundaries
Parsing creates objects in the AddressComponent hierarchy, which can then be used to create alternative arrangements using AddressDivisionGrouping or AddressStringDivisionSeries

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getBitCount()`
`byte[]`	`getBytes()`
`byte[]`	`getBytes(byte[] bytes)` Copies the bytes of the smallest address item represented by this address item into the supplied array, and returns that array.
`java.math.BigInteger`	`getCount()` The count of possible distinct values for this AddressComponent.
`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.
`boolean`	`includesMax()`
`boolean`	`includesZero()`
`boolean`	`isFullRange()`
`boolean`	`isMax()`
`boolean`	`isMultiple()` Whether this represents multiple potential values (eg a prefixed address or a segment representing a range of values)
`boolean`	`isZero()`

- Method Detail
  - getCount
```
java.math.BigInteger getCount()
```
    The count of possible distinct values for this AddressComponent. If not multiple, this is 1. For instance, if this is the ip address series subnet 0::/64, then the count is 2 to the power of 64. If this is a the segment 3-7, then the count is 5.
    
    Returns:
  - getBitCount
```
int getBitCount()
```
    Returns:
    
    the number of bits comprising this address item
  - isMultiple
```
boolean isMultiple()
```
    Whether this represents multiple potential values (eg a prefixed address or a segment representing a range of values)
  - getBytes
```
byte[] getBytes()
```
    Returns:
    
    the bytes of the smallest address item represented by this address item
  - getBytes
```
byte[] getBytes(byte[] bytes)
```
    Copies the bytes of the smallest 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.
    
    Returns:
    
    the bytes of the smallest address represented by this address item.
  - getUpperBytes
```
byte[] getUpperBytes()
```
    Returns:
    
    the bytes of the largest address item represented by this address item
  - 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. If the supplied array is null or of insufficient size, a new array is created and returned.
    
    Returns:
    
    the bytes of the largest address represented by this address item.
  - isZero
```
boolean isZero()
```
    Returns:
    
    whether this item matches the value of zero
  - includesZero
```
boolean includesZero()
```
    Returns:
    
    whether this item includes the value of zero within its range
  - isMax
```
boolean isMax()
```
    Returns:
    
    whether this item matches the maximum possible value
  - includesMax
```
boolean includesMax()
```
    Returns:
    
    whether this item includes the maximum possible value within its range
  - isFullRange
```
boolean isFullRange()
```
    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

getCount

getBitCount

isMultiple

getBytes

getBytes

getUpperBytes

getUpperBytes

isZero

includesZero

isMax

includesMax

isFullRange