MACAddressSegment

java.lang.Object
- inet.ipaddr.format.AddressDivisionBase
- - inet.ipaddr.format.AddressDivision
  - - inet.ipaddr.mac.MACAddressSegment

All Implemented Interfaces:

AddressComponent, AddressSegment, AddressItem, AddressStringDivision, java.io.Serializable, java.lang.Comparable<AddressDivision>, java.lang.Iterable<MACAddressSegment>
```
public class MACAddressSegment
extends AddressDivision
implements AddressSegment, java.lang.Iterable<MACAddressSegment>
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_CHARS

Fields
Modifier and Type	Field and Description
`static int`	`MAX_CHARS`

Constructor Summary

Constructors
Constructor and 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(AddressSegment other)`
`boolean`	`contains(MACAddressSegment 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()`
`long`	`getDivisionValueCount()`
`java.lang.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`	`getLowerSegmentValue()` returns the lower value
`long`	`getLowerValue()`
`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()`
`MACAddressSegment`	`getUpper()` If this segment represents a range of values, returns a segment representing just the highest value in the range, otherwise returns this.
`int`	`getUpperSegmentValue()` returns the upper value
`long`	`getUpperValue()`
`int`	`getValueCount()`
`int`	`hashCode()`
`boolean`	`isBoundedBy(int value)` Returns true if the possible values of this division fall below the given value.
`boolean`	`isFullRange()`
`java.util.Iterator<MACAddressSegment>`	`iterator()` Iterates through the individual elements of this address component.
`boolean`	`matches(int value)`
`boolean`	`matchesWithMask(int value, int mask)`
`boolean`	`matchesWithMask(int lowerValue, int upperValue, int mask)`
`MACAddressSegment`	`reverseBits()`
`MACAddressSegment`	`reverseBits(boolean perByte)` Returns a new AddressComponent with the bits reversed.
`MACAddressSegment`	`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 somewhat similar for all address components of the same type.
`java.lang.String`	`toNormalizedString(AddressDivisionGrouping.StringOptions options)`

Methods inherited from class inet.ipaddr.format.AddressDivision
compareTo, getCount, getDigitCount, getDivisionPrefixCount, getMaxDigitCount, hasUppercaseVariations, includesMax, includesZero, isMax, isMultiple, isZero, matches, matchesWithMask, matchesWithMask

Methods inherited from class inet.ipaddr.format.AddressDivisionBase
getBytes, getBytes, getDigitCount, getLowerStandardString, getStandardString, getString, getUpperBytes, getUpperBytes, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface inet.ipaddr.format.AddressItem
getBytes, getBytes, getCount, getUpperBytes, getUpperBytes, includesMax, includesZero, isMax, isMultiple, isZero

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - MAX_CHARS
```
public static final int MAX_CHARS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - 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 Detail
  - getNetwork
```
public MACAddressNetwork getNetwork()
```
    Specified by:
    
    getNetwork in interface AddressSegment
  - getValueCount
```
public int getValueCount()
```
    Specified by:
    
    getValueCount in interface AddressSegment
    
    Returns:
    
    the same value as AddressItem.getCount() as an integer
  - getDivisionValueCount
```
public long getDivisionValueCount()
```
    Overrides:
    
    getDivisionValueCount in class AddressDivision
  - getBitCount
```
public int getBitCount()
```
    Specified by:
    
    getBitCount in interface AddressItem
    
    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:
  - getMaxValue
```
public long getMaxValue()
```
    Overrides:
    
    getMaxValue in class AddressDivision
  - getLowerValue
```
public long getLowerValue()
```
    Specified by:
    
    getLowerValue in class AddressDivision
  - getUpperValue
```
public long getUpperValue()
```
    Specified by:
    
    getUpperValue in class AddressDivision
  - getLowerSegmentValue
```
public int getLowerSegmentValue()
```
    returns the lower value
    
    Specified by:
    
    getLowerSegmentValue 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 AddressComponent
    
    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 AddressComponent
    
    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 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Specified by:
    
    equals in interface AddressSegment
    
    Overrides:
    
    equals in class java.lang.Object
  - contains
```
public boolean contains(MACAddressSegment other)
```
    Parameters:
    
    other -
    
    Returns:
    
    whether this subnet segment contains the given address segment
  - isFullRange
```
public boolean isFullRange()
```
    Specified by:
    
    isFullRange in interface AddressItem
    
    Overrides:
    
    isFullRange in class AddressDivision
    
    Returns:
    
    whether this address item represents all possible values attainable by an address item of this type, or in other words, both includesZero() and includesMax() return true
  - 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
  - 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 java.lang.Iterable<MACAddressSegment> 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
    
    Returns:
  - iterator
```
public java.util.Iterator<MACAddressSegment> 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<MACAddressSegment>
  - 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:
  - contains
```
public boolean contains(AddressSegment other)
```
    Specified by:
    
    contains in interface AddressSegment
  - toHexString
```
public java.lang.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 java.lang.String toNormalizedString()
```
    Description copied from interface: AddressComponent
    
    Produces a string that is somewhat similar for all address components of the same type.
    
    Specified by:
    
    toNormalizedString in interface AddressComponent
    
    Returns:
  - toNormalizedString
```
public java.lang.String toNormalizedString(AddressDivisionGrouping.StringOptions options)
```

Methods inherited from class inet.ipaddr.format.AddressDivision

Methods inherited from class inet.ipaddr.format.AddressDivisionBase

Methods inherited from class java.lang.Object

Methods inherited from interface inet.ipaddr.format.AddressItem

Methods inherited from interface java.lang.Comparable

Methods inherited from interface java.lang.Iterable

MAX_CHARS

MACAddressSegment

MACAddressSegment

getNetwork

getValueCount

getDivisionValueCount

getBitCount

getByteCount

getMaxValue

getLowerValue

getUpperValue

getLowerSegmentValue

getUpperSegmentValue

getLower

getUpper

reverseBits

reverseBits

reverseBytes

isBoundedBy

hashCode

equals

contains

isFullRange

getDefaultTextualRadix

getMaxDigitCount

matches

matchesWithMask

matchesWithMask

getIterable

iterator

getMaxSegmentValue

contains

toHexString

toNormalizedString

toNormalizedString