AddressComponent

All Superinterfaces:

AddressItem, java.io.Serializable

All Known Subinterfaces:

AddressSection, AddressSegment, AddressSegmentSeries, IPAddressSegmentSeries

All Known Implementing Classes:

Address, IPAddress, IPAddressSection, IPAddressSegment, IPv4Address, IPv4AddressSection, IPv4AddressSegment, IPv6Address, IPv6AddressSection, IPv6AddressSegment, MACAddress, MACAddressSection, MACAddressSegment
```
public interface AddressComponent
extends AddressItem
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getByteCount()` returns the number of bytes in each of the address components represented by this instance
`java.lang.Iterable<? extends AddressComponent>`	`getIterable()` Useful for using an instance in a "for-each loop".
`AddressComponent`	`getLower()` If this instance represents multiple address components, returns the one with the lowest numeric value.
`AddressComponent`	`getUpper()` If this instance represents multiple address components, returns the one with the highest numeric value.
`java.util.Iterator<? extends AddressComponent>`	`iterator()` Iterates through the individual elements of this address component.
`AddressComponent`	`reverseBits(boolean perByte)` Returns a new AddressComponent with the bits reversed.
`AddressComponent`	`reverseBytes()` Returns an AddressComponent with the bytes reversed.
`java.lang.String`	`toHexString(boolean with0xPrefix)` Writes this address component as a single hexadecimal value with always the exact same number of characters, with or without a preceding 0x prefix.
`java.lang.String`	`toNormalizedString()` Produces a string that is somewhat similar for all address components of the same type.

Methods inherited from interface inet.ipaddr.format.AddressItem
getBitCount, getBytes, getBytes, getCount, getUpperBytes, getUpperBytes, includesMax, includesZero, isFullRange, isMax, isMultiple, isZero

- Method Detail
  - getLower
```
AddressComponent getLower()
```
    If this instance represents multiple address components, returns the one with the lowest numeric value.
    
    Returns:
  - getUpper
```
AddressComponent getUpper()
```
    If this instance represents multiple address components, returns the one with the highest numeric value.
    
    Returns:
  - getByteCount
```
int getByteCount()
```
    returns the number of bytes in each of the address components represented by this instance
    
    Returns:
  - getIterable
```
java.lang.Iterable<? extends AddressComponent> getIterable()
```
    Useful for using an instance in a "for-each loop". Otherwise just call iterator() directly.
    
    Returns:
  - iterator
```
java.util.Iterator<? extends AddressComponent> iterator()
```
    Iterates through the individual elements of this address component.
    An address component can represent a single segment, address, or section, or it can represent multiple, typically a subnet or range of segment, address, or section values.
    Call AddressItem.isMultiple() to determine if this instance represents multiple.
    
    Returns:
  - toHexString
```
java.lang.String toHexString(boolean with0xPrefix)
```
    Writes this address component as a single hexadecimal value with always the exact same number of characters, with or without a preceding 0x prefix.
    If this component represents a range of values outside of the network prefix length, then this is printed as a range of two hex values.
    For instance, for IPv4 addresses there are 8 hex characters, for IPv6 addresses there are 32 hex characters.
  - toNormalizedString
```
java.lang.String toNormalizedString()
```
    Produces a string that is somewhat similar for all address components of the same type.
    
    Returns:
  - reverseBits
```
AddressComponent reverseBits(boolean perByte)
```
    Returns a new AddressComponent with the bits reversed. If this component represents a range of values that cannot be reversed, then this throws IncompatibleAddressException. In a range the most significant bits stay constant while the least significant bits range over different values, so reversing that scenario results in a series of non-consecutive values, in most cases, which cannot be represented with a single AddressComponent object.
    In such cases where isMultiple() is true, call iterator(), getLower(), getUpper() or some other methods to break the series down into a series representing a single value.
    
    Parameters:
    
    perByte - if true, only the bits in each byte are reversed, if false, then all bits in the component are reversed
    
    Returns:
    
    Throws:
    
    IncompatibleAddressException - when subnet addresses cannot be reversed
  - reverseBytes
```
AddressComponent reverseBytes()
```
    Returns an AddressComponent with the bytes reversed. If this component represents a range of values that cannot be reversed, then this throws IncompatibleAddressException. In a range the most significant bits stay constant while the least significant bits range over different values, so reversing that scenario results in a series of non-consecutive values, in most cases, which cannot be represented with a single AddressComponent object.
    In such cases where isMultiple() is true, call iterator(), getLower(), getUpper() or some other methods to break the series down into a series representing a single value.
    
    Returns:
    
    Throws:
    
    IncompatibleAddressException - when subnet addresses cannot be reversed

Methods inherited from interface inet.ipaddr.format.AddressItem

getLower

getUpper

getByteCount

getIterable

iterator

toHexString

toNormalizedString

reverseBits

reverseBytes