inet.ipaddr

Interface AddressSegmentSeries

All Superinterfaces:

AddressComponent, AddressDivisionSeries, AddressItem, AddressStringDivisionSeries, java.io.Serializable

All Known Subinterfaces:

AddressSection

All Known Implementing Classes:

Address, IPAddress, IPAddressSection, IPv4Address, IPv4AddressSection, IPv6Address, IPv6AddressSection, MACAddress, MACAddressSection

public interface AddressSegmentSeries
extends AddressDivisionSeries, AddressComponent

Represents a series of address segments, each of equal byte size, the byte size being a whole number of bytes. Each segment can potentially range over multiple values, and thus this series of segments can represent many different values as well.

Method Summary

Modifier and Type	Method and Description
AddressSegmentSeries	adjustPrefixBySegment(boolean nextSegment) Increases or decreases prefix length to the next segment boundary.
AddressSegmentSeries	adjustPrefixLength(int adjustment) Increases or decreases prefix length by the given increment.
AddressSegmentSeries	applyPrefixLength(int networkPrefixLength) Applies the given prefix length to create a new segment series representing all segment series starting with the same prefix.
int	getBitsPerSegment()
int	getBytesPerSegment()
java.lang.Iterable<? extends AddressSegmentSeries>	getIterable() Useful for using an instance in a "for-each loop".
AddressSegmentSeries	getLower() If this instance represents multiple address components, returns the one with the lowest numeric value.
AddressSection	getSection(int index) Gets the subsection from the series starting from the given index
AddressSection	getSection(int index, int endIndex) Gets the subsection from the series starting from the given index and ending just before the give endIndex
AddressSegment	getSegment(int index)
int	getSegmentCount()
AddressSegment[]	getSegments()
void	getSegments(AddressSegment[] segs)
void	getSegments(int start, int end, AddressSegment[] segs, int index) get the segments from start to end and insert into the segs array at the the given index
AddressSegmentSeries	getUpper() If this instance represents multiple address components, returns the one with the highest numeric value.
java.util.Iterator<? extends AddressSegmentSeries>	iterator() 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.
AddressSegmentSeries	removePrefixLength() Removes the prefix.
AddressSegmentSeries	reverseBits(boolean perByte) Returns a new segment series with the bits reversed.
AddressSegmentSeries	reverseBytes() Returns a new segment series with the bytes reversed.
AddressSegmentSeries	reverseBytesPerSegment() Returns a new segment series with the bytes reversed within each segment.
AddressSegmentSeries	reverseSegments() Returns a new segment series with the segments reversed.
java.util.Iterator<? extends AddressSegment[]>	segmentsIterator()
AddressSegmentSeries	setPrefixLength(int prefixLength) Sets the prefix length.
java.lang.String	toCanonicalString() Produces the canonical representation of the address
java.lang.String	toCompressedString() Produces a short representation of the address while remaining within the confines of standard representation(s) of the address

Methods inherited from interface inet.ipaddr.format.AddressDivisionSeries

getDivision, getEquivalentPrefix, getMinPrefix, getPrefixLength, isMore, isMultipleByPrefix, isPrefixed, isRangeEquivalentToPrefix

Methods inherited from interface inet.ipaddr.format.AddressStringDivisionSeries

getDivisionCount

Methods inherited from interface inet.ipaddr.AddressComponent

getByteCount, toHexString, toNormalizedString

Methods inherited from interface inet.ipaddr.format.AddressItem

getBitCount, getBytes, getBytes, getCount, getUpperBytes, getUpperBytes, isFullRange, isMultiple, isZero

Method Detail

getSegmentCount

int getSegmentCount()

getBitsPerSegment

int getBitsPerSegment()

getBytesPerSegment

int getBytesPerSegment()

getSection

AddressSection getSection(int index)

Gets the subsection from the series starting from the given index

Parameters:

index -

Returns:

Throws:

java.lang.IndexOutOfBoundsException - if index < 0

getSection

AddressSection getSection(int index,
                          int endIndex)

Gets the subsection from the series starting from the given index and ending just before the give endIndex

Parameters:

index -

endIndex -

Returns:

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 or endIndex extends beyond the end of the series

getSegment

AddressSegment getSegment(int index)

getSegments

void getSegments(AddressSegment[] segs)

getSegments

void getSegments(int start,
                 int end,
                 AddressSegment[] segs,
                 int index)

get the segments from start to end and insert into the segs array at the the given index

Parameters:

start -

end -

segs -

index -

getSegments

AddressSegment[] getSegments()

getLower

AddressSegmentSeries getLower()

Description copied from interface: AddressComponent

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

Specified by:

getLower in interface AddressComponent

Returns:

getUpper

AddressSegmentSeries getUpper()

Description copied from interface: AddressComponent

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

Specified by:

getUpper in interface AddressComponent

Returns:

getIterable

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

Description copied from interface: AddressComponent

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

Specified by:

getIterable in interface AddressComponent

Returns:

iterator

java.util.Iterator<? extends AddressSegmentSeries> iterator()

Description copied from interface: AddressComponent

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. This method iterates through the individual elements.

Specified by:

iterator in interface AddressComponent

Returns:

segmentsIterator

java.util.Iterator<? extends AddressSegment[]> segmentsIterator()

toCanonicalString

java.lang.String toCanonicalString()

Produces the canonical representation of the address

Returns:

toCompressedString

java.lang.String toCompressedString()

Produces a short representation of the address while remaining within the confines of standard representation(s) of the address

Returns:

reverseSegments

AddressSegmentSeries reverseSegments()

Returns a new segment series with the segments reversed. This does not throw AddressTypeException.

Returns:

reverseBits

AddressSegmentSeries reverseBits(boolean perByte)

Returns a new segment series with the bits reversed.

Specified by:

reverseBits in interface AddressComponent

Parameters:

perByte - if true, only the bits in each byte are reversed, if false, then all bits in the component are reversed

Returns:

Throws:

AddressTypeException - if reversing the bits within a single segment cannot be done because the segment represents a range, and when all values in that range are reversed, the result is not contiguous. In practice this means that to be reversible the range must include all values except possibly the largest and/or smallest.

reverseBytes

AddressSegmentSeries reverseBytes()

Returns a new segment series with the bytes reversed.

Specified by:

reverseBytes in interface AddressComponent

Returns:

Throws:

AddressTypeException - if the segments have more than 1 bytes, and if reversing the bits within a single segment cannot be done because the segment represents a range that is not the entire segment range.

reverseBytesPerSegment

AddressSegmentSeries reverseBytesPerSegment()

Returns a new segment series with the bytes reversed within each segment.

Returns:

Throws:

AddressTypeException - if the segments have more than 1 bytes, and if reversing the bits within a single segment cannot be done because the segment represents a range that is not the entire segment range.

removePrefixLength

AddressSegmentSeries removePrefixLength()

Removes the prefix. When the series already had a prefix, the bits previously not within the prefix are zero.

Parameters:

nextSegment -

Returns:

adjustPrefixBySegment

AddressSegmentSeries adjustPrefixBySegment(boolean nextSegment)

Increases or decreases prefix length to the next segment boundary. When prefix length is increased, the bits moved within the prefix are zero.

Parameters:

nextSegment -

Returns:

adjustPrefixLength

AddressSegmentSeries adjustPrefixLength(int adjustment)

Increases or decreases prefix length by the given increment. When prefix length is increased, the bits moved within the prefix become zero. When the prefix is extended beyond the segment series boundary, it is removed.

Parameters:

nextSegment -

Returns:

setPrefixLength

AddressSegmentSeries setPrefixLength(int prefixLength)

Sets the prefix length. When the series already had a prefix, and the prefix length is increased, the bits moved within the prefix are zero. When the prefix is extended beyond the segment series boundary, it is removed.

Parameters:

nextSegment -

Returns:

applyPrefixLength

AddressSegmentSeries applyPrefixLength(int networkPrefixLength)

Applies the given prefix length to create a new segment series representing all segment series starting with the same prefix. When this series already has a prefix length that is smaller, then this method returns this series.