inet.ipaddr

Interface AddressComponent

All Superinterfaces:

AddressItem, AddressItemRange, java.lang.Comparable<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 AddressItemRange

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<? extends AddressComponent>	getIterable() Useful for using an instance in a "for-each loop".
AddressComponent	getLower() If this instance represents multiple address items, returns the one with the lowest numeric value.
AddressComponent	getUpper() If this instance represents multiple address items, 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 consistent for all address components of the same type and version, and is also similar to the canonical string AddressSegmentSeries.toCanonicalString() in AddressComponent instances that are also AddressSegmentSeries instances.

Methods inherited from interface inet.ipaddr.format.AddressItem

compareTo, containsPrefixBlock, containsSinglePrefixBlock, getBitCount, getByteCount, getBytes, getBytes, getBytes, getCount, getMinPrefixLengthForBlock, getPrefixCount, getPrefixLengthForSingleBlock, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isZero, testRange, testRange

Method Detail

toHexString

java.lang.String toHexString(boolean with0xPrefix)
                      throws IncompatibleAddressException

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.

Throws:

IncompatibleAddressException

toNormalizedString

java.lang.String toNormalizedString()

Produces a string that is consistent for all address components of the same type and version, and is also similar to the canonical string AddressSegmentSeries.toCanonicalString() in AddressComponent instances that are also AddressSegmentSeries instances.

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

getLower

AddressComponent getLower()

Description copied from interface: AddressItemRange

If this instance represents multiple address items, returns the one with the lowest numeric value.

Specified by:

getLower in interface AddressItemRange

Returns:

getUpper

AddressComponent getUpper()

Description copied from interface: AddressItemRange

If this instance represents multiple address items, returns the one with the highest numeric value.

Specified by:

getUpper in interface AddressItemRange

Returns:

getIterable

java.lang.Iterable<? extends AddressComponent> getIterable()

Description copied from interface: AddressItemRange

Useful for using an instance in a "for-each loop". Otherwise just call AddressItemRange.iterator() directly.

Specified by:

getIterable in interface AddressItemRange

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 of addresses or a range of segment or section values.

Call AddressItem.isMultiple() to determine if this instance represents multiple.

Specified by:

iterator in interface AddressItemRange

Returns: