inet.ipaddr.ipv4

Class IPv4AddressSegment

java.lang.Object

inet.ipaddr.format.AddressDivisionBase

inet.ipaddr.format.AddressDivision

inet.ipaddr.format.IPAddressDivision

inet.ipaddr.IPAddressSegment

inet.ipaddr.ipv4.IPv4AddressSegment

All Implemented Interfaces:

AddressComponent, AddressSegment, AddressItem, AddressStringDivision, IPAddressStringDivision, java.io.Serializable, java.lang.Comparable<AddressDivision>, java.lang.Iterable<IPv4AddressSegment>

public class IPv4AddressSegment
extends IPAddressSegment
implements java.lang.Iterable<IPv4AddressSegment>

This represents a segment of an IP address. For IPv4, segments are 1 byte. For IPv6, they are two bytes. Like String and Integer and various others basic objects, segments are immutable, which also makes them thread-safe.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CHARS When printed with the default radix of 10, the max number of characters per segment

Constructor Summary

Constructors

Constructor and Description
IPv4AddressSegment(int value) Constructs a segment of an IPv4 address with the given value.
IPv4AddressSegment(int value, java.lang.Integer segmentPrefixLength) Constructs a segment of an IPv4 address.
IPv4AddressSegment(int lower, int upper, java.lang.Integer segmentPrefixLength) Constructs a segment of an IPv4 address that represents a range of values.

Method Summary

Modifier and Type	Method and Description
boolean	contains(AddressSegment other)
boolean	equals(java.lang.Object other)
int	getBitCount()
int	getByteCount() returns the number of bytes in each of the address components represented by this instance
int	getDefaultTextualRadix()
IPAddress.IPVersion	getIPVersion()
java.lang.Iterable<IPv4AddressSegment>	getIterable() Useful for using an instance in a "for-each loop".
IPv4AddressSegment	getLower() If this segment represents a range of values, returns a segment representing just the lowest value in the range, otherwise returns this.
int	getMaxDigitCount()
int	getMaxSegmentValue() Gets the maximum possible value for this type of segment (for the highest range value of this particular segment, use AddressSegment.getUpper()
IPv4AddressNetwork	getNetwork()
IPv4AddressNetwork.IPv4AddressCreator	getSegmentCreator()
IPv4AddressSegment	getUpper() If this segment represents a range of values, returns a segment representing just the highest value in the range, otherwise returns this.
boolean	isIPv4()
java.util.Iterator<IPv4AddressSegment>	iterator() Iterates through the individual elements of this address component.
IPv6AddressSegment	join(IPv6AddressNetwork.IPv6AddressCreator creator, IPv4AddressSegment low) Joins with another IPv4 segment to produce a IPv6 segment.
java.util.Iterator<IPv4AddressSegment>	prefixBlockIterator() Iterates through the individual prefix blocks.
IPv4AddressSegment	removePrefixLength()
IPv4AddressSegment	removePrefixLength(boolean zeroed)
IPv4AddressSegment	reverseBits()
IPv4AddressSegment	reverseBits(boolean perByte) Returns a new AddressComponent with the bits reversed.
IPv4AddressSegment	reverseBytes() Returns an AddressComponent with the bytes reversed.
IPv4AddressSegment	toHostSegment(java.lang.Integer bits) used by getHostSection, see IPAddressSegmentSeries.getHostSection(int)
IPv4AddressSegment	toNetworkSegment(java.lang.Integer segmentPrefixLength) used by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)
IPv4AddressSegment	toNetworkSegment(java.lang.Integer segmentPrefixLength, boolean withPrefixLength) used by getNetworkSection and by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)

Methods inherited from class inet.ipaddr.IPAddressSegment

getBitCount, getByteCount, getDefaultTextualRadix, getDivisionValueCount, getLowerSegmentValue, getLowerValue, getMaxSegmentValue, getMaxValue, getMinPrefixLengthForBlock, getPrefixValueCount, getSegmentPrefixLength, getUpperSegmentValue, getUpperValue, getValueCount, hashCode, includesMax, includesZero, isBitwiseOrCompatibleWithRange, isBoundedBy, isIPv6, isMaskCompatibleWithRange, isMultiple, isPrefixBlock, matches, matchesWithMask, matchesWithMask, matchesWithPrefixMask, toHexString, toNormalizedString, toNormalizedString

Methods inherited from class inet.ipaddr.format.IPAddressDivision

getBlockMaskPrefixLength, getDivisionPrefixLength, getPrefixAdjustedRangeString, getString, getWildcardString, isPrefixBlock, isPrefixed, isSinglePrefixBlock, isSinglePrefixBlock, matchesWithPrefixMask

Methods inherited from class inet.ipaddr.format.AddressDivision

compareTo, getCount, getDigitCount, getDivisionPrefixCount, getMaxDigitCount, hasUppercaseVariations, isFullRange, isMax, isZero, matches, matchesWithMask, matchesWithMask

Methods inherited from class inet.ipaddr.format.AddressDivisionBase

getBytes, getBytes, getDigitCount, getLowerStandardString, getStandardString, getUpperBytes, getUpperBytes, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface inet.ipaddr.format.AddressItem

getBytes, getBytes, getCount, getUpperBytes, getUpperBytes, isFullRange, isMax, isZero

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface inet.ipaddr.format.IPAddressStringDivision

isFullRange

Methods inherited from interface inet.ipaddr.format.AddressStringDivision

getDigitCount, getLowerStandardString, getMaxDigitCount, getStandardString

Field Detail

MAX_CHARS

public static final int MAX_CHARS

When printed with the default radix of 10, the max number of characters per segment

See Also:

Constant Field Values

Constructor Detail

IPv4AddressSegment

public IPv4AddressSegment(int value)
                   throws AddressValueException

Constructs a segment of an IPv4 address with the given value.

Parameters:

value - the value of the segment

Throws:

AddressValueException - if value is negative or too large

IPv4AddressSegment

public IPv4AddressSegment(int value,
                          java.lang.Integer segmentPrefixLength)
                   throws AddressValueException

Constructs a segment of an IPv4 address.

Parameters:

value - the value of the segment. If the segmentPrefixLength is non-null, the network prefix of the value is used, and the segment represents all segment values with the same network prefix.

segmentPrefixLength - the segment prefix, which can be null

Throws:

AddressValueException - if value or prefix length is negative or too large

IPv4AddressSegment

public IPv4AddressSegment(int lower,
                          int upper,
                          java.lang.Integer segmentPrefixLength)
                   throws AddressValueException

Constructs a segment of an IPv4 address that represents a range of values.

Parameters:

segmentPrefixLength - the segment prefix length, which can be null. If segmentPrefixLength is non-null, this segment represents a range of segment values with the given network prefix length.

lower - the lower value of the range of values represented by the segment. If segmentPrefixLength is non-null, the lower value becomes the smallest value with the same network prefix.

upper - the upper value of the range of values represented by the segment. If segmentPrefixLength is non-null, the upper value becomes the largest value with the same network prefix.

Throws:

AddressValueException - if either lower or upper value or prefix length is negative or too large

Method Detail

isIPv4

public boolean isIPv4()

Overrides:

isIPv4 in class IPAddressSegment

getIPVersion

public IPAddress.IPVersion getIPVersion()

Specified by:

getIPVersion in class IPAddressSegment

getMaxSegmentValue

public int getMaxSegmentValue()

Description copied from interface: AddressSegment

Gets the maximum possible value for this type of segment (for the highest range value of this particular segment, use AddressSegment.getUpper()

Specified by:

getMaxSegmentValue in interface AddressSegment

Returns:

toNetworkSegment

public IPv4AddressSegment toNetworkSegment(java.lang.Integer segmentPrefixLength)

Description copied from class: IPAddressSegment

used by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)

Overrides:

toNetworkSegment in class IPAddressSegment

toNetworkSegment

public IPv4AddressSegment toNetworkSegment(java.lang.Integer segmentPrefixLength,
                                           boolean withPrefixLength)

Description copied from class: IPAddressSegment

used by getNetworkSection and by constructors of IPAddressSection, see IPAddressSegmentSeries.getNetworkSection(int, boolean)

Specified by:

toNetworkSegment in class IPAddressSegment

toHostSegment

public IPv4AddressSegment toHostSegment(java.lang.Integer bits)

Description copied from class: IPAddressSegment

used by getHostSection, see IPAddressSegmentSeries.getHostSection(int)

Specified by:

toHostSegment in class IPAddressSegment

getLower

public IPv4AddressSegment getLower()

Description copied from class: IPAddressSegment

If this segment represents a range of values, returns a segment representing just the lowest value in the range, otherwise returns this.

Specified by:

getLower in interface AddressComponent

Specified by:

getLower in interface AddressSegment

Specified by:

getLower in class IPAddressSegment

Returns:

getUpper

public IPv4AddressSegment getUpper()

Description copied from class: IPAddressSegment

If this segment represents a range of values, returns a segment representing just the highest value in the range, otherwise returns this.

Specified by:

getUpper in interface AddressComponent

Specified by:

getUpper in interface AddressSegment

Specified by:

getUpper in class IPAddressSegment

Returns:

getNetwork

public IPv4AddressNetwork getNetwork()

Specified by:

getNetwork in interface AddressSegment

Specified by:

getNetwork in class IPAddressSegment

getSegmentCreator

public IPv4AddressNetwork.IPv4AddressCreator getSegmentCreator()

getIterable

public java.lang.Iterable<IPv4AddressSegment> 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 AddressSegment

Specified by:

getIterable in class IPAddressSegment

Returns:

iterator

public java.util.Iterator<IPv4AddressSegment> iterator()

Description copied from interface: AddressComponent

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.

Specified by:

iterator in interface AddressComponent

Specified by:

iterator in interface AddressSegment

Specified by:

iterator in interface java.lang.Iterable<IPv4AddressSegment>

Specified by:

iterator in class IPAddressSegment

Returns:

prefixBlockIterator

public java.util.Iterator<IPv4AddressSegment> prefixBlockIterator()

Description copied from class: IPAddressSegment

Iterates through the individual prefix blocks. If the series has no prefix length, then this is equivalent to IPAddressSegment.iterator()

Specified by:

prefixBlockIterator in class IPAddressSegment

getBitCount

public int getBitCount()

Specified by:

getBitCount in interface AddressItem

Specified by:

getBitCount in interface IPAddressStringDivision

Returns:

the number of bits comprising this address item

getByteCount

public int getByteCount()

Description copied from interface: AddressComponent

returns the number of bytes in each of the address components represented by this instance

Specified by:

getByteCount in interface AddressComponent

Returns:

getDefaultTextualRadix

public int getDefaultTextualRadix()

Specified by:

getDefaultTextualRadix in class AddressDivisionBase

Returns:

the default radix for textual representations of addresses (10 for IPv4, 16 for IPv6)

getMaxDigitCount

public int getMaxDigitCount()

Specified by:

getMaxDigitCount in class AddressDivisionBase

Returns:

the number of digits for the maximum possible value of the division when using the default radix

reverseBits

public IPv4AddressSegment reverseBits(boolean perByte)

Description copied from interface: AddressComponent

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.

Specified by:

reverseBits in interface AddressComponent

Specified by:

reverseBits in interface AddressSegment

Specified by:

reverseBits in class IPAddressSegment

Parameters:

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

Returns:

reverseBits

public IPv4AddressSegment reverseBits()

reverseBytes

public IPv4AddressSegment reverseBytes()

Description copied from interface: AddressComponent

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.

Specified by:

reverseBytes in interface AddressComponent

Specified by:

reverseBytes in interface AddressSegment

Specified by:

reverseBytes in class IPAddressSegment

Returns:

removePrefixLength

public IPv4AddressSegment removePrefixLength(boolean zeroed)

Specified by:

removePrefixLength in class IPAddressSegment

removePrefixLength

public IPv4AddressSegment removePrefixLength()

Specified by:

removePrefixLength in class IPAddressSegment

contains

public boolean contains(AddressSegment other)

Specified by:

contains in interface AddressSegment

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface AddressSegment

Overrides:

equals in class java.lang.Object

join

public IPv6AddressSegment join(IPv6AddressNetwork.IPv6AddressCreator creator,
                               IPv4AddressSegment low)
                        throws IncompatibleAddressException

Joins with another IPv4 segment to produce a IPv6 segment.

Parameters:

creator -

low -

Returns:

Throws:

IncompatibleAddressException