inet.ipaddr

Interface AddressSection

All Superinterfaces:

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

All Known Implementing Classes:

IPAddressSection, IPv4AddressSection, IPv6AddressSection, MACAddressSection

public interface AddressSection
extends AddressSegmentSeries

Core

Method Summary

Modifier and Type	Method and Description
AddressSection	adjustPrefixBySegment(boolean nextSegment) Increases or decreases prefix length to the next segment boundary.
AddressSection	adjustPrefixLength(int adjustment) Increases or decreases prefix length by the given increment.
AddressSection	applyPrefixLength(int networkPrefixLength) Applies the given prefix length to create a new segment series representing all segment series starting with the same prefix.
boolean	contains(AddressSection other) Determines if one section contains another.
java.lang.Iterable<? extends AddressSection>	getIterable() Useful for using an instance in a "for-each loop".
AddressSection	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
AddressSection	getUpper() If this instance represents multiple address components, returns the one with the highest numeric value.
java.util.Iterator<? extends AddressSection>	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.
AddressSection	removePrefixLength() Removes the prefix.
AddressSection	reverseBits(boolean perByte) Returns a new segment series with the bits reversed.
AddressSection	reverseBytes() Returns a new segment series with the bytes reversed.
AddressSection	reverseBytesPerSegment() Returns a new segment series with the bytes reversed within each segment.
AddressSection	reverseSegments() Returns a new segment series with the segments reversed.
AddressSection	setPrefixLength(int prefixLength) Sets the prefix length.

Methods inherited from interface inet.ipaddr.AddressSegmentSeries

getBitsPerSegment, getBytesPerSegment, getSegment, getSegmentCount, getSegments, getSegments, getSegments, segmentsIterator, toCanonicalString, toCompressedString

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

contains

boolean contains(AddressSection other)

Determines if one section contains another. Sections must have the same number of segments to be comparable. For sections which are aware of their position in an address (IPv6 and MAC), their respective positions must match to be comparable.

Parameters:

other -

Returns:

whether this section contains the given address section

getSection

AddressSection getSection(int index)

Description copied from interface: AddressSegmentSeries

Gets the subsection from the series starting from the given index

Specified by:

getSection in interface AddressSegmentSeries

Returns:

getSection

AddressSection getSection(int index,
                          int endIndex)

Description copied from interface: AddressSegmentSeries

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

Specified by:

getSection in interface AddressSegmentSeries

Returns:

getLower

AddressSection 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

Specified by:

getLower in interface AddressSegmentSeries

Returns:

getUpper

AddressSection 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

Specified by:

getUpper in interface AddressSegmentSeries

Returns:

reverseSegments

AddressSection reverseSegments()

Description copied from interface: AddressSegmentSeries

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

Specified by:

reverseSegments in interface AddressSegmentSeries

Returns:

reverseBits

AddressSection reverseBits(boolean perByte)

Description copied from interface: AddressSegmentSeries

Returns a new segment series with the bits reversed.

Specified by:

reverseBits in interface AddressComponent

Specified by:

reverseBits in interface AddressSegmentSeries

Parameters:

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

Returns:

reverseBytes

AddressSection reverseBytes()

Description copied from interface: AddressSegmentSeries

Returns a new segment series with the bytes reversed.

Specified by:

reverseBytes in interface AddressComponent

Specified by:

reverseBytes in interface AddressSegmentSeries

Returns:

reverseBytesPerSegment

AddressSection reverseBytesPerSegment()

Description copied from interface: AddressSegmentSeries

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

Specified by:

reverseBytesPerSegment in interface AddressSegmentSeries

Returns:

removePrefixLength

AddressSection removePrefixLength()

Description copied from interface: AddressSegmentSeries

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

Specified by:

removePrefixLength in interface AddressSegmentSeries

Returns:

adjustPrefixBySegment

AddressSection adjustPrefixBySegment(boolean nextSegment)

Description copied from interface: AddressSegmentSeries

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

Specified by:

adjustPrefixBySegment in interface AddressSegmentSeries

Returns:

adjustPrefixLength

AddressSection adjustPrefixLength(int adjustment)

Description copied from interface: AddressSegmentSeries

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.

Specified by:

adjustPrefixLength in interface AddressSegmentSeries

Returns:

setPrefixLength

AddressSection setPrefixLength(int prefixLength)

Description copied from interface: AddressSegmentSeries

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.

Specified by:

setPrefixLength in interface AddressSegmentSeries

Returns:

applyPrefixLength

AddressSection applyPrefixLength(int networkPrefixLength)

Description copied from interface: AddressSegmentSeries

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.

Specified by:

applyPrefixLength in interface AddressSegmentSeries

getIterable

java.lang.Iterable<? extends AddressSection> 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

Specified by:

getIterable in interface AddressSegmentSeries

Returns:

iterator

java.util.Iterator<? extends AddressSection> 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

Specified by:

iterator in interface AddressSegmentSeries

Returns: