Class MACAddressSegment

java.lang.Object

inet.ipaddr.format.AddressDivisionBase

inet.ipaddr.format.standard.AddressDivision

inet.ipaddr.mac.MACAddressSegment

All Implemented Interfaces:

AddressComponent, AddressSegment, AddressComponentRange, AddressGenericDivision, AddressItem, AddressItemRange, AddressStringDivision, Serializable, Comparable<AddressItem>, Iterable<MACAddressSegment>

public class MACAddressSegment
extends AddressDivision
implements AddressSegment, Iterable<MACAddressSegment>

Represents a segment of a MAC address. For MAC, segments are 1 byte. Segments are immutable, which also makes them thread-safe.

Author:

sfoley

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AddressDivision

AddressDivision.BitwiseOrResult, AddressDivision.MaskResult

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_CHARS

Fields inherited from class AddressDivisionBase

EXTENDED_DIGITS

Constructor Summary

Constructors

Constructor	Description
MACAddressSegment(int value)	Constructs a segment of an IPv4 or IPv6 address with the given value.
MACAddressSegment(int lower, int upper)	Constructs a segment of a MAC address that represents a range of values.

Method Summary

Modifier and Type	Method	Description
boolean	contains(AddressSegment other)
boolean	contains(MACAddressSegment other)
boolean	containsPrefixBlock(int divisionPrefixLen)	Returns whether the values of this series contains the prefix block for the given prefix length.
boolean	containsSinglePrefixBlock(int divisionPrefixLen)	Returns whether the division range matches exactly the block of values for the given prefix length.
boolean	equals(Object other)	Two divisions are equal if they: - they match type/version (ipv4, ipv6, mac, or a specific division class) - match bit counts - match values Prefix lengths, for those divisions that have them, are ignored.
int	getBitCount()	Provides the number of bits comprising this address item
int	getByteCount()	Provides the number of bytes required for this address item, rounding up if the bit count is not a multiple of 8
int	getDefaultTextualRadix()
long	getDivisionValue()
Iterable<MACAddressSegment>	getIterable()	Useful for using an instance in a "for-each loop".
MACAddressSegment	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()
long	getMaxValue()
MACAddressNetwork	getNetwork()	Returns the network object for components of the same version (eg IPv4, IPv6 and MAC each have their own network object)
int	getPrefixValueCount(int segmentPrefixLength)	Returns the count of prefix values in this address segment for the given prefix bit count.
int	getSegmentValue()	returns the lower value
MACAddressSegment	getUpper()	If this segment represents a range of values, returns a segment representing just the highest value in the range, otherwise returns this.
long	getUpperDivisionValue()
int	getUpperSegmentValue()	returns the upper value
int	getValueCount()	Returns the count of values in this address segment.
int	hashCode()
boolean	isBoundedBy(int value)	Returns true if the possible values of this division fall below the given value.
Iterator<MACAddressSegment>	iterator()	Iterates through the individual address components.
boolean	matches(int value)
boolean	matchesWithMask(int value, int mask)
boolean	matchesWithMask(int lowerValue, int upperValue, int mask)
boolean	overlaps(AddressSegment other)
boolean	prefixEquals(AddressSegment o, int segmentPrefixLength)	Returns whether the given prefix bits match the same bits of the given segment.
MACAddressSegment	reverseBits()
MACAddressSegment	reverseBits(boolean perByte)	Returns a new AddressComponent with the bits reversed.
MACAddressSegment	reverseBytes()	Returns an AddressComponent with the bytes reversed.
AddressComponentSpliterator<MACAddressSegment>	spliterator()	Partitions and traverses through the individual address components.
Stream<MACAddressSegment>	stream()	Returns a sequential stream of the individual address components.
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.
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.
String	toNormalizedString(AddressDivisionGrouping.StringOptions options)

Methods inherited from class AddressDivision

bitwiseOrRange, getDigitCount, getMaxDigitCount, getMinPrefixLengthForBlock, getPrefixLengthForSingleBlock, getUpperValue, getValue, hasUppercaseVariations, includesMax, includesZero, isBitwiseOrCompatibleWithRange, isMaskCompatibleWithRange, isMax, isMultiple, isZero, maskRange, matches, matchesWithMask, matchesWithMask

Methods inherited from class AddressDivisionBase

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AddressItem

compareTo, getBytes, getBytes, getBytes, getCount, getMinPrefixLengthForBlock, getPrefixCount, getPrefixLengthForSingleBlock, getUpperBytes, getUpperBytes, getUpperBytes, getUpperValue, getValue, includesMax, includesZero, isFullRange, isMax, isMultiple, isZero

Methods inherited from interface AddressSegment

isOneBit, testBit

Methods inherited from interface AddressStringDivision

getDigitCount, getLowerStandardString, getMaxDigitCount, getStandardString

Methods inherited from interface Iterable

forEach

Field Details

MAX_CHARS

public static final int MAX_CHARS

See Also:

• Constant Field Values

Constructor Details

MACAddressSegment

public MACAddressSegment(int value)

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

Parameters:

value - the value of the segment

Throws:

AddressValueException - if value is negative or too large

MACAddressSegment

public MACAddressSegment(int lower,
 int upper)

Constructs a segment of a MAC address that represents a range of values.

Parameters:

lower - the lower value of the range of values represented by the segment.

upper - the upper value of the range of values represented by the segment.

Throws:

AddressValueException - if value is negative or too large

Method Details

getNetwork

public MACAddressNetwork getNetwork()

Description copied from interface: AddressComponent

Returns the network object for components of the same version (eg IPv4, IPv6 and MAC each have their own network object)

Specified by:

getNetwork in interface AddressComponent

Returns:

getValueCount

public int getValueCount()

Description copied from interface: AddressSegment

Returns the count of values in this address segment.

Specified by:

getValueCount in interface AddressSegment

Returns:

the same value as AddressItem.getCount() as an integer

getPrefixValueCount

public int getPrefixValueCount(int segmentPrefixLength)

Description copied from interface: AddressSegment

Returns the count of prefix values in this address segment for the given prefix bit count.

Specified by:

getPrefixValueCount in interface AddressSegment

Returns:

the count of values

getBitCount

public int getBitCount()

Description copied from interface: AddressItem

Provides the number of bits comprising this address item

Specified by:

getBitCount in interface AddressItem

Returns:

the number of bits

getByteCount

public int getByteCount()

Description copied from interface: AddressItem

Provides the number of bytes required for this address item, rounding up if the bit count is not a multiple of 8

Specified by:

getByteCount in interface AddressItem

Returns:

the number of bytes

getMaxValue

public long getMaxValue()

Overrides:

getMaxValue in class AddressDivision

getDivisionValue

public long getDivisionValue()

Specified by:

getDivisionValue in class AddressDivision

getUpperDivisionValue

public long getUpperDivisionValue()

Specified by:

getUpperDivisionValue in class AddressDivision

getSegmentValue

public int getSegmentValue()

returns the lower value

Specified by:

getSegmentValue in interface AddressSegment

getUpperSegmentValue

public int getUpperSegmentValue()

returns the upper value

Specified by:

getUpperSegmentValue in interface AddressSegment

getLower

public MACAddressSegment getLower()

Description copied from interface: AddressSegment

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 AddressComponentRange

Specified by:

getLower in interface AddressSegment

Returns:

getUpper

public MACAddressSegment getUpper()

Description copied from interface: AddressSegment

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 AddressComponentRange

Specified by:

getUpper in interface AddressSegment

Returns:

reverseBits

public MACAddressSegment 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

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 MACAddressSegment reverseBits()

reverseBytes

public MACAddressSegment 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

Returns:

isBoundedBy

public boolean isBoundedBy(int value)

Description copied from class: AddressDivision

Returns true if the possible values of this division fall below the given value.

Specified by:

isBoundedBy in interface AddressStringDivision

Overrides:

isBoundedBy in class AddressDivision

hashCode

public int hashCode()

Overrides:

hashCode in class AddressDivision

equals

public boolean equals(Object other)

Description copied from class: AddressDivisionBase

Two divisions are equal if they: - they match type/version (ipv4, ipv6, mac, or a specific division class) - match bit counts - match values Prefix lengths, for those divisions that have them, are ignored.

Specified by:

equals in interface AddressSegment

Overrides:

equals in class AddressDivision

contains

public boolean contains(MACAddressSegment other)

Parameters:

other -

Returns:

whether this subnet segment contains the given address segment

getDefaultTextualRadix

public int getDefaultTextualRadix()

getMaxDigitCount

public int getMaxDigitCount()

matches

public boolean matches(int value)

Specified by:

matches in interface AddressSegment

matchesWithMask

public boolean matchesWithMask(int value,
 int mask)

Specified by:

matchesWithMask in interface AddressSegment

matchesWithMask

public boolean matchesWithMask(int lowerValue,
 int upperValue,
 int mask)

Specified by:

matchesWithMask in interface AddressSegment

getIterable

public Iterable<MACAddressSegment> getIterable()

Description copied from interface: AddressComponentRange

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

Specified by:

getIterable in interface AddressComponentRange

Specified by:

getIterable in interface AddressSegment

Returns:

iterator

public Iterator<MACAddressSegment> iterator()

Description copied from interface: AddressComponentRange

Iterates through the individual address components.

An address component can represent an individual 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, or AddressItem.getCount() for the count.

Specified by:

iterator in interface AddressComponentRange

Specified by:

iterator in interface AddressSegment

Specified by:

iterator in interface Iterable<MACAddressSegment>

Returns:

spliterator

public AddressComponentSpliterator<MACAddressSegment> spliterator()

Description copied from interface: AddressComponentRange

Partitions and traverses through the individual address components.

Specified by:

spliterator in interface AddressComponent

Specified by:

spliterator in interface AddressComponentRange

Specified by:

spliterator in interface AddressSegment

Specified by:

spliterator in interface Iterable<MACAddressSegment>

Returns:

stream

public Stream<MACAddressSegment> stream()

Description copied from interface: AddressComponentRange

Returns a sequential stream of the individual address components. For a parallel stream, call BaseStream.parallel() on the returned stream.

Specified by:

stream in interface AddressComponentRange

Specified by:

stream in interface AddressSegment

Returns:

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:

prefixEquals

public boolean prefixEquals(AddressSegment o,
 int segmentPrefixLength)

Description copied from interface: AddressSegment

Returns whether the given prefix bits match the same bits of the given segment.

Specified by:

prefixEquals in interface AddressSegment

Parameters:

o -

segmentPrefixLength -

Returns:

overlaps

public boolean overlaps(AddressSegment other)

Specified by:

overlaps in interface AddressSegment

contains

public boolean contains(AddressSegment other)

Specified by:

contains in interface AddressSegment

toHexString

public String toHexString(boolean with0xPrefix)

Description copied from interface: AddressComponent

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.

Specified by:

toHexString in interface AddressComponent

toNormalizedString

public String toNormalizedString()

Description copied from interface: AddressComponent

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.

Specified by:

toNormalizedString in interface AddressComponent

Returns:

toNormalizedString

public String toNormalizedString(AddressDivisionGrouping.StringOptions options)

containsPrefixBlock

public boolean containsPrefixBlock(int divisionPrefixLen)

Description copied from interface: AddressItem

Returns whether the values of this series contains the prefix block for the given prefix length.

Use AddressItem.getMinPrefixLengthForBlock() to determine the smallest prefix length for which this method returns true.

Specified by:

containsPrefixBlock in interface AddressItem

Parameters:

divisionPrefixLen -

Returns:

whether the division range includes the block of values for the given prefix length

containsSinglePrefixBlock

public boolean containsSinglePrefixBlock(int divisionPrefixLen)

Returns whether the division range matches exactly the block of values for the given prefix length.

Specified by:

containsSinglePrefixBlock in interface AddressItem

Parameters:

divisionPrefixLen -

Returns:

whether the range of this division matches the range for a single prefix with a single value and the given prefix length.