MACAddress (IPAddress javadoc by seancfoley)

java.lang.Object
- inet.ipaddr.Address
- - inet.ipaddr.mac.MACAddress

All Implemented Interfaces:

AddressComponent, AddressSegmentSeries, AddressComponentRange, AddressDivisionSeries, AddressItem, AddressItemRange, AddressStringDivisionSeries, Serializable, Comparable<AddressItem>, Iterable<MACAddress>
```
public class MACAddress
extends Address
implements Iterable<MACAddress>
```
A MAC address, or a collection of multiple MAC addresses. Each segment can represent a single value or a range of values.
You can construct a MAC address from a byte array, from a long, from a Address.SegmentValueProvider, from a NetworkInterface, from a MACAddressSection of 6 or 8 segments, or from an array of 6 or 8 MACAddressSegment objects.
To construct one from a String use MACAddressString.toAddress() or MACAddressString.getAddress()

See Also:

Serialized Form

Core

Nested Class Summary
- Nested classes/interfaces inherited from class inet.ipaddr.Address
  Address.AddressValueProvider, Address.SegmentValueProvider

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BITS_PER_SEGMENT`
`static int`	`BYTES_PER_SEGMENT`
`static char`	`COLON_SEGMENT_SEPARATOR`
`static char`	`DASH_SEGMENT_SEPARATOR`
`static char`	`DASHED_SEGMENT_RANGE_SEPARATOR`
`static String`	`DASHED_SEGMENT_RANGE_SEPARATOR_STR`
`static int`	`DEFAULT_TEXTUAL_RADIX`
`static char`	`DOTTED_SEGMENT_SEPARATOR`
`static int`	`EXTENDED_UNIQUE_IDENTIFIER_48_BIT_COUNT`
`static int`	`EXTENDED_UNIQUE_IDENTIFIER_48_SEGMENT_COUNT`
`static int`	`EXTENDED_UNIQUE_IDENTIFIER_64_BIT_COUNT`
`static int`	`EXTENDED_UNIQUE_IDENTIFIER_64_SEGMENT_COUNT`
`static int`	`MAX_VALUE_PER_DOTTED_SEGMENT`
`static int`	`MAX_VALUE_PER_SEGMENT`
`static int`	`MEDIA_ACCESS_CONTROL_BIT_COUNT`
`static int`	`MEDIA_ACCESS_CONTROL_DOTTED_64_SEGMENT_COUNT`
`static int`	`MEDIA_ACCESS_CONTROL_DOTTED_BITS_PER_SEGMENT`
`static int`	`MEDIA_ACCESS_CONTROL_DOTTED_SEGMENT_COUNT`
`static int`	`MEDIA_ACCESS_CONTROL_SEGMENT_COUNT`
`static int`	`MEDIA_ACCESS_CONTROL_SINGLE_DASHED_SEGMENT_COUNT`
`static int`	`ORGANIZATIONAL_UNIQUE_IDENTIFIER_BIT_COUNT`
`static int`	`ORGANIZATIONAL_UNIQUE_IDENTIFIER_SEGMENT_COUNT`
`static char`	`SPACE_SEGMENT_SEPARATOR`

Fields inherited from class inet.ipaddr.Address
ADDRESS_HIGH_VALUE_COMPARATOR, ADDRESS_LOW_VALUE_COMPARATOR, ALTERNATIVE_RANGE_SEPARATOR, ALTERNATIVE_RANGE_SEPARATOR_STR, ALTERNATIVE_SEGMENT_WILDCARD_STR, DEFAULT_ADDRESS_COMPARATOR, HEX_PREFIX, OCTAL_PREFIX, RANGE_SEPARATOR, RANGE_SEPARATOR_STR, SEGMENT_SQL_SINGLE_WILDCARD, SEGMENT_SQL_SINGLE_WILDCARD_STR, SEGMENT_SQL_WILDCARD, SEGMENT_SQL_WILDCARD_STR, SEGMENT_WILDCARD, SEGMENT_WILDCARD_STR

Constructor Summary

Constructors
Constructor and Description
`MACAddress(Address.SegmentValueProvider valueProvider)` Constructs a MAC address
`MACAddress(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider)` Constructs a MAC address
`MACAddress(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, boolean extended)` Constructs a MAC address
`MACAddress(Address.SegmentValueProvider valueProvider, boolean extended)` Constructs a MAC address
`MACAddress(byte[] bytes)` Constructs a MAC address.
`MACAddress(long address)` Constructs a MAC address.
`MACAddress(long address, boolean extended)` Constructs a MAC address.
`MACAddress(MACAddressSection section)` Constructs a MAC address.
`MACAddress(MACAddressSegment[] segments)` Constructs a MAC address.
`MACAddress(NetworkInterface ni)` Constructs a MAC address for a network interface.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MACAddress`	`adjustPrefixBySegment(boolean nextSegment)` Increases or decreases prefix length to the next segment boundary.
`MACAddress`	`adjustPrefixBySegment(boolean nextSegment, boolean zeroed)` Increases or decreases prefix length to the next segment boundary.
`MACAddress`	`adjustPrefixLength(int adjustment)` Increases or decreases prefix length by the given increment.
`MACAddress`	`adjustPrefixLength(int adjustment, boolean zeroed)` Increases or decreases prefix length by the given increment.
`MACAddress`	`applyPrefixLength(int prefixLength)` Deprecated.
`BigInteger`	`enumerate(Address other)` Indicates where an address sits relative to the subnet ordering.
`MACAddressNetwork.MACAddressCreator`	`getAddressCreator()`
`int`	`getBitCount()` Provides the number of bits comprising this address item
`int`	`getBitsPerSegment()` Returns the number of bits comprising each segment in this series.
`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`	`getBytesPerSegment()` Returns the number of bytes comprising each segment in this series.
`MACAddressSegment`	`getDivision(int index)`
`AddressDivisionGrouping`	`getDottedAddress()`
`IPv6AddressNetwork`	`getIPv6Network()`
`Iterable<MACAddress>`	`getIterable()` Useful for using an instance in a "for-each loop".
`MACAddress`	`getLower()` If this represents a series with ranging values, returns a series representing the lower values of the range.
`int`	`getMaxSegmentValue()` Returns the maximum possible segment value for this type of address.
`MACAddressNetwork`	`getNetwork()` Returns the network object for components of the same version (eg IPv4, IPv6 and MAC each have their own network object)
`MACAddressSection`	`getODISection()`
`MACAddressSection`	`getOUISection()`
`MACAddressSection`	`getSection()` Gets the subsection from the series that comprises all segments
`MACAddressSection`	`getSection(int index)` Gets the subsection from the series starting from the given index The first segment is at index 0.
`MACAddressSection`	`getSection(int index, int endIndex)` Gets the subsection from the series starting from the given index and ending just before the give endIndex The first segment is at index 0.
`MACAddressSegment`	`getSegment(int index)` Returns the segment from this series at the given index.
`MACAddressSegment[]`	`getSegments()` Returns the segments of this series of segments as an array.
`MACAddress`	`getUpper()` If this represents a series with ranging values, returns a series representing the upper values of the range.
`MACAddress`	`increment(long increment)` Returns the series from the subnet that is the given increment upwards into the subnet range, with the increment of 0 returning the first address in the range.
`MACAddress`	`incrementBoundary(long increment)` If the given increment is positive, adds the value to the upper series (`AddressSegmentSeries.getUpper()`) in the subnet range to produce a new series.
`boolean`	`isAllAddresses()`
`boolean`	`isEUI64(boolean asMAC)` Whether this section is consistent with an IPv6 EUI64 section, which means it came from an extended 8 byte address, and the corresponding segments in the middle match 0xff and 0xff/fe for MAC/not-MAC
`boolean`	`isExtended()`
`boolean`	`isLocal()` Local MAC addresses have the second least significant bit of the first octet set to 1.
`boolean`	`isMACAddress()` Returns whether this address is a MAC address
`boolean`	`isMulticast()` Multicast MAC addresses have the least significant bit of the first octet set to 1.
`boolean`	`isUnicast()`
`boolean`	`isUniversal()` Universal MAC addresses have second the least significant bit of the first octet set to 0.
`Iterator<MACAddress>`	`iterator()` Iterates through the individual address components.
`long`	`longValue()`
`static int`	`maxSegmentValue()`
`Iterator<MACAddress>`	`prefixBlockIterator()` Iterates through the individual prefix blocks.
`AddressComponentSpliterator<MACAddress>`	`prefixBlockSpliterator()` Partitions and traverses through the individual prefix blocks for the prefix length of this series.
`Stream<MACAddress>`	`prefixBlockStream()` Returns a sequential stream of the individual prefix blocks for the prefix length of this series.
`Iterator<MACAddress>`	`prefixIterator()` Iterates through the individual prefixes.
`AddressComponentSpliterator<MACAddress>`	`prefixSpliterator()` Partitions and traverses through the individual prefixes for the prefix length of this series.
`Stream<MACAddress>`	`prefixStream()` Returns a sequential stream of the individual prefixes for the prefix length of this series.
`MACAddress`	`removePrefixLength()` Deprecated.
`MACAddress`	`removePrefixLength(boolean zeroed)` Deprecated.
`MACAddress`	`replace(int startIndex, int endIndex, MACAddress replacement, int replacementIndex)` Replaces segments starting from startIndex and ending before endIndex with the same number of segments starting at replacementStartIndex from the replacement section
`MACAddress`	`replace(int startIndex, MACAddressSection replacement)` Replaces segments starting from startIndex with as many segments as possible from the replacement section
`MACAddress`	`reverseBits(boolean perByte)` Use to produce: "MSB format", "IBM format", "Token-Ring format", and "non-canonical form" See RFC 2469 section 2 Also see https://en.wikipedia.org/wiki/MAC_address
`MACAddress`	`reverseBytes()` Returns a new segment series with the bytes reversed.
`MACAddress`	`reverseBytesPerSegment()` Returns a new segment series with the bytes reversed within each segment.
`MACAddress`	`reverseSegments()` Returns a new segment series with the segments reversed.
`Iterator<MACAddressSegment[]>`	`segmentsIterator()` Iterates through the individual segments.
`AddressComponentRangeSpliterator<MACAddress,MACAddressSegment[]>`	`segmentsSpliterator()` Partitions and traverses through the individual segment arrays.
`Stream<MACAddressSegment[]>`	`segmentsStream()` Returns a sequential stream of the individual segment arrays.
`MACAddress`	`setPrefixLength(int prefixLength)` Sets the prefix length.
`MACAddress`	`setPrefixLength(int prefixLength, boolean zeroed)` Sets the prefix length.
`AddressComponentSpliterator<MACAddress>`	`spliterator()` Partitions and traverses through the individual address components.
`Stream<MACAddress>`	`stream()` Returns a sequential stream of the individual address components.
`MACAddressString`	`toAddressString()` Returns a host identifier string representation for this address, which will be already validated.
`String`	`toColonDelimitedString()`
`String`	`toDashedString()`
`String`	`toDottedString()`
`MACAddress`	`toEUI64(boolean asMAC)` Convert to IPv6 EUI-64 section http://standards.ieee.org/develop/regauth/tut/eui64.pdf
`IPv6AddressSection`	`toEUI64IPv6()` Converts to an Ipv6 address section.
`IPv6Address`	`toLinkLocalIPv6()` Converts to a link-local Ipv6 address.
`MACAddress`	`toMACAddress()` If this address is a MAC address, returns that `MACAddress`.
`String`	`toNormalizedString(AddressDivisionGrouping.StringOptions stringOptions)`
`MACAddress`	`toOUIPrefixBlock()` Returns an address in which the range of values match the block for the OUI (organizationally unique identifier)
`MACAddress`	`toPrefixBlock()` If this series has a prefix length, returns the block for that prefix.
`String`	`toSpaceDelimitedString()`
`String`	`toString()`
`long`	`upperLongValue()`
`MACAddress`	`withoutPrefixLength()` Provides the same address with no prefix.

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

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface inet.ipaddr.AddressSegmentSeries
isOneBit, testBit

Methods inherited from interface inet.ipaddr.format.AddressDivisionSeries
getSequentialBlockIndex, isMore

Methods inherited from interface inet.ipaddr.format.AddressComponentRange
stream, stream

Methods inherited from interface inet.ipaddr.format.AddressItem
compareTo, getBitsForCount, getBlockSize

- Field Detail
  - COLON_SEGMENT_SEPARATOR
```
public static final char COLON_SEGMENT_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - DASH_SEGMENT_SEPARATOR
```
public static final char DASH_SEGMENT_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - SPACE_SEGMENT_SEPARATOR
```
public static final char SPACE_SEGMENT_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - DOTTED_SEGMENT_SEPARATOR
```
public static final char DOTTED_SEGMENT_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - DASHED_SEGMENT_RANGE_SEPARATOR
```
public static final char DASHED_SEGMENT_RANGE_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - DASHED_SEGMENT_RANGE_SEPARATOR_STR
```
public static final String DASHED_SEGMENT_RANGE_SEPARATOR_STR
```
  - BITS_PER_SEGMENT
```
public static final int BITS_PER_SEGMENT
```
    See Also:
    
    Constant Field Values
  - BYTES_PER_SEGMENT
```
public static final int BYTES_PER_SEGMENT
```
    See Also:
    
    Constant Field Values
  - MEDIA_ACCESS_CONTROL_SEGMENT_COUNT
```
public static final int MEDIA_ACCESS_CONTROL_SEGMENT_COUNT
```
    See Also:
    
    Constant Field Values
  - MEDIA_ACCESS_CONTROL_BIT_COUNT
```
public static final int MEDIA_ACCESS_CONTROL_BIT_COUNT
```
    See Also:
    
    Constant Field Values
  - MEDIA_ACCESS_CONTROL_DOTTED_SEGMENT_COUNT
```
public static final int MEDIA_ACCESS_CONTROL_DOTTED_SEGMENT_COUNT
```
    See Also:
    
    Constant Field Values
  - MEDIA_ACCESS_CONTROL_DOTTED_64_SEGMENT_COUNT
```
public static final int MEDIA_ACCESS_CONTROL_DOTTED_64_SEGMENT_COUNT
```
    See Also:
    
    Constant Field Values
  - MEDIA_ACCESS_CONTROL_DOTTED_BITS_PER_SEGMENT
```
public static final int MEDIA_ACCESS_CONTROL_DOTTED_BITS_PER_SEGMENT
```
    See Also:
    
    Constant Field Values
  - MEDIA_ACCESS_CONTROL_SINGLE_DASHED_SEGMENT_COUNT
```
public static final int MEDIA_ACCESS_CONTROL_SINGLE_DASHED_SEGMENT_COUNT
```
    See Also:
    
    Constant Field Values
  - EXTENDED_UNIQUE_IDENTIFIER_48_SEGMENT_COUNT
```
public static final int EXTENDED_UNIQUE_IDENTIFIER_48_SEGMENT_COUNT
```
    See Also:
    
    Constant Field Values
  - EXTENDED_UNIQUE_IDENTIFIER_64_SEGMENT_COUNT
```
public static final int EXTENDED_UNIQUE_IDENTIFIER_64_SEGMENT_COUNT
```
    See Also:
    
    Constant Field Values
  - EXTENDED_UNIQUE_IDENTIFIER_48_BIT_COUNT
```
public static final int EXTENDED_UNIQUE_IDENTIFIER_48_BIT_COUNT
```
    See Also:
    
    Constant Field Values
  - EXTENDED_UNIQUE_IDENTIFIER_64_BIT_COUNT
```
public static final int EXTENDED_UNIQUE_IDENTIFIER_64_BIT_COUNT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TEXTUAL_RADIX
```
public static final int DEFAULT_TEXTUAL_RADIX
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_PER_SEGMENT
```
public static final int MAX_VALUE_PER_SEGMENT
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE_PER_DOTTED_SEGMENT
```
public static final int MAX_VALUE_PER_DOTTED_SEGMENT
```
    See Also:
    
    Constant Field Values
  - ORGANIZATIONAL_UNIQUE_IDENTIFIER_SEGMENT_COUNT
```
public static final int ORGANIZATIONAL_UNIQUE_IDENTIFIER_SEGMENT_COUNT
```
    See Also:
    
    Constant Field Values
  - ORGANIZATIONAL_UNIQUE_IDENTIFIER_BIT_COUNT
```
public static final int ORGANIZATIONAL_UNIQUE_IDENTIFIER_BIT_COUNT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MACAddress
```
public MACAddress(MACAddressSegment[] segments)
           throws AddressValueException
```
    Constructs a MAC address.
    
    Parameters:
    
    segments - the address segments
    
    Throws:
    
    AddressValueException
  - MACAddress
```
public MACAddress(MACAddressSection section)
           throws AddressValueException
```
    Constructs a MAC address.
    
    Parameters:
    
    section - the address segments
    
    Throws:
    
    AddressValueException
  - MACAddress
```
public MACAddress(long address)
           throws AddressValueException
```
    Constructs a MAC address.
    
    Throws:
    
    AddressValueException
  - MACAddress
```
public MACAddress(NetworkInterface ni)
           throws SocketException
```
    Constructs a MAC address for a network interface.
    
    Throws:
    
    SocketException
  - MACAddress
```
public MACAddress(long address,
                  boolean extended)
           throws AddressValueException
```
    Constructs a MAC address.
    
    Throws:
    
    AddressValueException
  - MACAddress
```
public MACAddress(byte[] bytes)
           throws AddressValueException
```
    Constructs a MAC address.
    
    Throws:
    
    AddressValueException
  - MACAddress
```
public MACAddress(Address.SegmentValueProvider lowerValueProvider,
                  Address.SegmentValueProvider upperValueProvider,
                  boolean extended)
```
    Constructs a MAC address
    
    Parameters:
    
    lowerValueProvider - supplies the 1 byte lower values for each segment
    
    upperValueProvider - supplies the 1 byte upper values for each segment
  - MACAddress
```
public MACAddress(Address.SegmentValueProvider lowerValueProvider,
                  Address.SegmentValueProvider upperValueProvider)
```
    Constructs a MAC address
    
    Parameters:
    
    lowerValueProvider - supplies the 1 byte lower values for each segment
    
    upperValueProvider - supplies the 1 byte upper values for each segment
  - MACAddress
```
public MACAddress(Address.SegmentValueProvider valueProvider,
                  boolean extended)
           throws AddressValueException
```
    Constructs a MAC address
    
    Parameters:
    
    valueProvider - supplies the 1 byte value for each segment
    
    Throws:
    
    AddressValueException
  - MACAddress
```
public MACAddress(Address.SegmentValueProvider valueProvider)
```
    Constructs a MAC address
    
    Parameters:
    
    valueProvider - supplies the 1 byte value for each segment
- Method Detail
  - enumerate
```
public BigInteger enumerate(Address other)
```
    Description copied from class: Address
    Indicates where an address sits relative to the subnet ordering.
    Determines how many address elements of a subnet precede the given address element, if the address is in the subnet. If above the subnet range, it is the distance to the upper boundary added to the subnet address count less one, and if below the subnet range, the distance to the lower boundary.
    In other words, if the given address is not in the subnet but above it, returns the number of addresses preceding the address from the upper subnet boundary, added to one less than the total number of subnet addresses. If the given address is not in the subnet but below it, returns the number of addresses following the address to the lower subnet boundary.
    enumerate returns null when the argument is a multi-valued subnet. The argument must be an individual address.
    When this address is also single-valued, the returned value is the distance (difference) between this address and the argument address.
    enumerate is the inverse of the increment method:
    - subnet.enumerate(subnet.increment(inc)) = inc
    - subnet.increment(subnet.enumerate(newAddr)) = newAddr
    If the given address does not have the same version or type as this subnet or address, then null is returned.
    Specified by:
    
    enumerate in class Address
  - 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:
  - getIPv6Network
```
public IPv6AddressNetwork getIPv6Network()
```
  - getAddressCreator
```
public MACAddressNetwork.MACAddressCreator getAddressCreator()
```
  - isExtended
```
public boolean isExtended()
```
  - isMACAddress
```
public boolean isMACAddress()
```
    Description copied from class: Address
    
    Returns whether this address is a MAC address
    
    Overrides:
    
    isMACAddress in class Address
    
    Returns:
    
    whether this address is a MAC address
  - toMACAddress
```
public MACAddress toMACAddress()
```
    Description copied from class: Address
    
    If this address is a MAC address, returns that MACAddress. Otherwise, returns null.
    
    Overrides:
    
    toMACAddress in class Address
    
    Returns:
    
    the MAC address
  - isAllAddresses
```
public boolean isAllAddresses()
```
  - getSection
```
public MACAddressSection getSection()
```
    Description copied from interface: AddressSegmentSeries
    
    Gets the subsection from the series that comprises all segments
    
    Specified by:
    
    getSection in interface AddressSegmentSeries
    
    Overrides:
    
    getSection in class Address
    
    Returns:
  - getDivision
```
public MACAddressSegment getDivision(int index)
```
    Specified by:
    
    getDivision in interface AddressDivisionSeries
    
    Specified by:
    
    getDivision in interface AddressStringDivisionSeries
    
    Returns:
    
    the given division in this series. The first is at index 0.
  - getSegment
```
public MACAddressSegment getSegment(int index)
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the segment from this series at the given index. The first segment is at index 0. A segment is an address division, see AddressDivisionSeries.getDivision(int), the difference being that all segments in a given series are the same bit count, while divisions can have variable length.
    
    Specified by:
    
    getSegment in interface AddressSegmentSeries
    
    Returns:
  - getSegments
```
public MACAddressSegment[] getSegments()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the segments of this series of segments as an array. This must create a new array, so for efficiency use AddressSegmentSeries.getSegment(int) and AddressSegmentSeries.getSegmentCount() instead when feasible.
    
    Specified by:
    
    getSegments in interface AddressSegmentSeries
    
    Returns:
  - maxSegmentValue
```
public static int maxSegmentValue()
```
  - getMaxSegmentValue
```
public int getMaxSegmentValue()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the maximum possible segment value for this type of address. Note this is not the maximum value of the range of segment values in this specific address, this is the maximum value of any segment for this address type, and is usually determined by the number of bits per segment.
    
    Specified by:
    
    getMaxSegmentValue in interface AddressSegmentSeries
    
    Returns:
    
    the maximum possible segment value for a series of the same type
  - 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
    
    Overrides:
    
    getByteCount in class Address
    
    Returns:
    
    the number of bytes
  - getBitCount
```
public int getBitCount()
```
    Description copied from interface: AddressItem
    
    Provides the number of bits comprising this address item
    
    Specified by:
    
    getBitCount in interface AddressDivisionSeries
    
    Specified by:
    
    getBitCount in interface AddressItem
    
    Overrides:
    
    getBitCount in class Address
    
    Returns:
    
    the number of bits
  - getBytesPerSegment
```
public int getBytesPerSegment()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the number of bytes comprising each segment in this series. Segments in the same series are equal length.
    
    Specified by:
    
    getBytesPerSegment in interface AddressSegmentSeries
    
    Returns:
  - getBitsPerSegment
```
public int getBitsPerSegment()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the number of bits comprising each segment in this series. Segments in the same series are equal length.
    
    Specified by:
    
    getBitsPerSegment in interface AddressSegmentSeries
    
    Returns:
  - getIterable
```
public Iterable<MACAddress> 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 AddressSegmentSeries
    
    Specified by:
    
    getIterable in interface AddressComponentRange
    
    Specified by:
    
    getIterable in class Address
    
    Returns:
  - iterator
```
public Iterator<MACAddress> 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 AddressSegmentSeries
    
    Specified by:
    
    iterator in interface AddressComponentRange
    
    Specified by:
    
    iterator in interface Iterable<MACAddress>
    
    Specified by:
    
    iterator in class Address
    
    Returns:
  - spliterator
```
public AddressComponentSpliterator<MACAddress> 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 AddressSegmentSeries
    
    Specified by:
    
    spliterator in interface AddressComponentRange
    
    Specified by:
    
    spliterator in interface Iterable<MACAddress>
    
    Specified by:
    
    spliterator in class Address
    
    Returns:
  - stream
```
public Stream<MACAddress> 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 AddressSegmentSeries
    
    Specified by:
    
    stream in interface AddressComponentRange
    
    Specified by:
    
    stream in class Address
    
    Returns:
  - prefixBlockIterator
```
public Iterator<MACAddress> prefixBlockIterator()
```
    Description copied from interface: AddressSegmentSeries
    
    Iterates through the individual prefix blocks.
    If the series has no prefix length, then this is equivalent to AddressSegmentSeries.iterator()
    
    Specified by:
    
    prefixBlockIterator in interface AddressSegmentSeries
    
    Specified by:
    
    prefixBlockIterator in class Address
  - prefixBlockSpliterator
```
public AddressComponentSpliterator<MACAddress> prefixBlockSpliterator()
```
    Description copied from interface: AddressSegmentSeries
    
    Partitions and traverses through the individual prefix blocks for the prefix length of this series.
    
    Specified by:
    
    prefixBlockSpliterator in interface AddressSegmentSeries
    
    Specified by:
    
    prefixBlockSpliterator in class Address
    
    Returns:
  - prefixBlockStream
```
public Stream<MACAddress> prefixBlockStream()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns a sequential stream of the individual prefix blocks for the prefix length of this series. For a parallel stream, call BaseStream.parallel() on the returned stream.
    
    Specified by:
    
    prefixBlockStream in interface AddressSegmentSeries
    
    Specified by:
    
    prefixBlockStream in class Address
    
    Returns:
  - prefixIterator
```
public Iterator<MACAddress> prefixIterator()
```
    Description copied from interface: AddressSegmentSeries
    
    Iterates through the individual prefixes.
    If the series has no prefix length, then this is equivalent to AddressSegmentSeries.iterator()
    
    Specified by:
    
    prefixIterator in interface AddressSegmentSeries
    
    Specified by:
    
    prefixIterator in class Address
  - prefixSpliterator
```
public AddressComponentSpliterator<MACAddress> prefixSpliterator()
```
    Description copied from interface: AddressSegmentSeries
    
    Partitions and traverses through the individual prefixes for the prefix length of this series.
    
    Specified by:
    
    prefixSpliterator in interface AddressSegmentSeries
    
    Specified by:
    
    prefixSpliterator in class Address
    
    Returns:
  - prefixStream
```
public Stream<MACAddress> prefixStream()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns a sequential stream of the individual prefixes for the prefix length of this series. For a parallel stream, call BaseStream.parallel() on the returned stream.
    
    Specified by:
    
    prefixStream in interface AddressSegmentSeries
    
    Specified by:
    
    prefixStream in class Address
    
    Returns:
  - segmentsIterator
```
public Iterator<MACAddressSegment[]> segmentsIterator()
```
    Description copied from interface: AddressSegmentSeries
    
    Iterates through the individual segments.
    
    Specified by:
    
    segmentsIterator in interface AddressSegmentSeries
  - segmentsSpliterator
```
public AddressComponentRangeSpliterator<MACAddress,MACAddressSegment[]> segmentsSpliterator()
```
    Description copied from interface: AddressSegmentSeries
    
    Partitions and traverses through the individual segment arrays.
    
    Specified by:
    
    segmentsSpliterator in interface AddressSegmentSeries
    
    Returns:
  - segmentsStream
```
public Stream<MACAddressSegment[]> segmentsStream()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns a sequential stream of the individual segment arrays. For a parallel stream, call BaseStream.parallel() on the returned stream.
    
    Specified by:
    
    segmentsStream in interface AddressSegmentSeries
    
    Returns:
  - increment
```
public MACAddress increment(long increment)
```
    Description copied from interface: AddressSegmentSeries
    
    Returns the series from the subnet that is the given increment upwards into the subnet range, with the increment of 0 returning the first address in the range.
    If the subnet has multiple values and the increment exceeds the subnet size, then the amount by which it exceeds the size - 1 is added to the upper series of the range (the final iterator value).
    If the increment is negative, it is added to the lower series of the range (the first iterator value).
    If the subnet is just a single address values, the series is simply incremented by the given value, positive or negative.
    If a subnet has multiple values, a positive increment value is equivalent to the same number of values from the AddressSegmentSeries.iterator() For instance, a increment of 0 is the first value from the iterator, an increment of 1 is the second value from the iterator, and so on. A negative increment added to the subnet count is equivalent to the same number of values preceding the upper bound of the iterator. For instance, an increment of count - 1 is the last value from the iterator, an increment of count - 2 is the second last value, and so on.
    An increment of size count gives you the series just above the highest series of the subnet. To get the series just below the lowest series of the subnet, use the increment -1.
    
    Specified by:
    
    increment in interface AddressSegmentSeries
    
    Specified by:
    
    increment in class Address
    
    Returns:
  - incrementBoundary
```
public MACAddress incrementBoundary(long increment)
```
    Description copied from interface: AddressSegmentSeries
    
    If the given increment is positive, adds the value to the upper series (AddressSegmentSeries.getUpper()) in the subnet range to produce a new series. If the given increment is negative, adds the value to the lower series (AddressSegmentSeries.getLower()) in the subnet range to produce a new series. If the increment is zero, returns this.
    In the case where the series is a single value, this simply returns the address produced by adding the given increment to this address series.
    
    Specified by:
    
    incrementBoundary in interface AddressSegmentSeries
    
    Specified by:
    
    incrementBoundary in class Address
    
    Returns:
  - getLower
```
public MACAddress getLower()
```
    Description copied from interface: AddressSegmentSeries
    
    If this represents a series with ranging values, returns a series representing the lower values of the range. If this represents an series with a single value in each segment, returns this.
    
    Specified by:
    
    getLower in interface AddressSegmentSeries
    
    Specified by:
    
    getLower in interface AddressComponentRange
    
    Specified by:
    
    getLower in class Address
    
    Returns:
  - getUpper
```
public MACAddress getUpper()
```
    Description copied from interface: AddressSegmentSeries
    
    If this represents a series with ranging values, returns a series representing the upper values of the range. If this represents a series with a single value in each segment, returns this.
    
    Specified by:
    
    getUpper in interface AddressSegmentSeries
    
    Specified by:
    
    getUpper in interface AddressComponentRange
    
    Specified by:
    
    getUpper in class Address
    
    Returns:
  - longValue
```
public long longValue()
```
  - upperLongValue
```
public long upperLongValue()
```
  - reverseBits
```
public MACAddress reverseBits(boolean perByte)
```
    Use to produce: "MSB format", "IBM format", "Token-Ring format", and "non-canonical form" See RFC 2469 section 2 Also see https://en.wikipedia.org/wiki/MAC_address
    
    Specified by:
    
    reverseBits in interface AddressComponent
    
    Specified by:
    
    reverseBits in interface AddressSegmentSeries
    
    Specified by:
    
    reverseBits in class Address
    
    Parameters:
    
    perByte - if true, only the bits in each byte are reversed, if false, then all bits in the component are reversed
    
    Returns:
  - reverseBytes
```
public MACAddress 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
    
    Specified by:
    
    reverseBytes in class Address
    
    Returns:
  - reverseBytesPerSegment
```
public MACAddress reverseBytesPerSegment()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns a new segment series with the bytes reversed within each segment.
    
    Specified by:
    
    reverseBytesPerSegment in interface AddressSegmentSeries
    
    Specified by:
    
    reverseBytesPerSegment in class Address
    
    Returns:
  - reverseSegments
```
public MACAddress reverseSegments()
```
    Description copied from interface: AddressSegmentSeries
    
    Returns a new segment series with the segments reversed. This does not throw IncompatibleAddressException since all address series can reverse their segments.
    
    Specified by:
    
    reverseSegments in interface AddressSegmentSeries
    
    Specified by:
    
    reverseSegments in class Address
    
    Returns:
  - removePrefixLength
```
@Deprecated
public MACAddress removePrefixLength()
```
    Deprecated.
    
    Description copied from interface: AddressSegmentSeries
    
    Removes the prefix length while zeroing out the bits beyond the prefix.
    If the series already has a prefix length, the bits outside the prefix become zero. Use AddressSegmentSeries.withoutPrefixLength() to remove the prefix length without changing the series values.
    Equivalent to calling removePrefixLength(true)
    
    Specified by:
    
    removePrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    removePrefixLength in class Address
    
    Returns:
    
    See Also:
    
    for an alternative which does not change the address series values.
  - withoutPrefixLength
```
public MACAddress withoutPrefixLength()
```
    Description copied from interface: AddressSegmentSeries
    
    Provides the same address with no prefix. The values remain unchanged.
    Use AddressSegmentSeries.removePrefixLength() as an alternative that deletes the host at the same time by zeroing the host values.
    
    Specified by:
    
    withoutPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    withoutPrefixLength in class Address
  - removePrefixLength
```
@Deprecated
public MACAddress removePrefixLength(boolean zeroed)
```
    Deprecated.
    
    Description copied from interface: AddressSegmentSeries
    
    Removes the prefix length. If zeroed is false, the bits that were host bits do not become zero, unlike AddressSegmentSeries.removePrefixLength()
    
    Specified by:
    
    removePrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    removePrefixLength in class Address
    
    Parameters:
    
    zeroed - whether the bits outside the prefix become zero
    
    Returns:
  - applyPrefixLength
```
@Deprecated
public MACAddress applyPrefixLength(int prefixLength)
```
    Deprecated.
    
    Description copied from interface: AddressSegmentSeries
    
    Applies the given prefix length to create a new segment series.
    Similar to AddressSegmentSeries.setPrefixLength(int) except that prefix lengths are never increased. When this series already has a prefix length that is less than or equal to the requested prefix length, this series is returned.
    Otherwise the returned series has the given prefix length.
    The bits moved outside the prefix will become zero in the returned series.
    
    Specified by:
    
    applyPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    applyPrefixLength in class Address
    
    Returns:
    
    See Also:
    
    AddressSegmentSeries.setPrefixLength(int)
  - adjustPrefixBySegment
```
public MACAddress adjustPrefixBySegment(boolean nextSegment)
```
    Description copied from interface: AddressSegmentSeries
    
    Increases or decreases prefix length to the next segment boundary.
    Follows the same rules as AddressSegmentSeries.adjustPrefixLength(int):
    When prefix length is increased, the bits moved within the prefix become zero. When a prefix length is decreased, the bits moved outside the prefix become zero. To avoid the zeroing behaviour, use AddressSegmentSeries.adjustPrefixBySegment(boolean, boolean) with second arg false.
    
    Specified by:
    
    adjustPrefixBySegment in interface AddressSegmentSeries
    
    Specified by:
    
    adjustPrefixBySegment in class Address
    
    Parameters:
    
    nextSegment - whether to move prefix to previous or following segment boundary
    
    Returns:
  - adjustPrefixBySegment
```
public MACAddress adjustPrefixBySegment(boolean nextSegment,
                                        boolean zeroed)
```
    Description copied from interface: AddressSegmentSeries
    
    Increases or decreases prefix length to the next segment boundary.
    
    Specified by:
    
    adjustPrefixBySegment in interface AddressSegmentSeries
    
    Specified by:
    
    adjustPrefixBySegment in class Address
    
    Parameters:
    
    nextSegment - whether to move prefix to previous or following segment boundary
    
    zeroed - whether the bits that move from one side of the prefix to the other become zero or retain their original values
    
    Returns:
  - adjustPrefixLength
```
public MACAddress 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. When a prefix length is decreased, the bits moved outside the prefix become zero. To avoid the zeroing behaviour, use AddressSegmentSeries.adjustPrefixLength(int, boolean) with second arg false.
    
    Specified by:
    
    adjustPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    adjustPrefixLength in class Address
    
    Returns:
  - adjustPrefixLength
```
public MACAddress adjustPrefixLength(int adjustment,
                                     boolean zeroed)
```
    Description copied from interface: AddressSegmentSeries
    
    Increases or decreases prefix length by the given increment.
    
    Specified by:
    
    adjustPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    adjustPrefixLength in class Address
    
    Parameters:
    
    adjustment - the increment
    
    zeroed - whether the bits that move from one side of the prefix to the other become zero or retain their original values
    
    Returns:
  - setPrefixLength
```
public MACAddress setPrefixLength(int prefixLength)
```
    Description copied from interface: AddressSegmentSeries
    
    Sets the prefix length.
    If this series has a prefix length, and the prefix length is increased, the bits moved within the prefix become zero. For an alternative that does not set bits to zero, use AddressSegmentSeries.setPrefixLength(int, boolean) with the second argument as false.
    When the prefix is extended beyond the segment series boundary, it is removed.
    The bits that move from one side of the prefix length to the other (ie bits moved into the prefix or outside the prefix) are zeroed.
    
    Specified by:
    
    setPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    setPrefixLength in class Address
    
    Returns:
  - setPrefixLength
```
public MACAddress setPrefixLength(int prefixLength,
                                  boolean zeroed)
```
    Description copied from interface: AddressSegmentSeries
    
    Sets the prefix length.
    When the prefix is extended beyond the segment series boundary, it is removed.
    
    Specified by:
    
    setPrefixLength in interface AddressSegmentSeries
    
    Specified by:
    
    setPrefixLength in class Address
    
    zeroed - whether the bits that move from one side of the prefix length to the other (ie bits moved into the prefix or outside the prefix) are zeroed.
    
    Returns:
  - getSection
```
public MACAddressSection getSection(int index)
```
    Description copied from interface: AddressSegmentSeries
    
    Gets the subsection from the series starting from the given index The first segment is at index 0.
    
    Specified by:
    
    getSection in interface AddressSegmentSeries
    
    Returns:
  - getSection
```
public MACAddressSection 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 The first segment is at index 0.
    
    Specified by:
    
    getSection in interface AddressSegmentSeries
    
    Returns:
  - getODISection
```
public MACAddressSection getODISection()
```
  - getOUISection
```
public MACAddressSection getOUISection()
```
  - toOUIPrefixBlock
```
public MACAddress toOUIPrefixBlock()
```
    Returns an address in which the range of values match the block for the OUI (organizationally unique identifier)
    
    Returns:
  - toPrefixBlock
```
public MACAddress toPrefixBlock()
```
    Description copied from interface: AddressSegmentSeries
    
    If this series has a prefix length, returns the block for that prefix. Otherwise, this address series is returned.
    
    Specified by:
    
    toPrefixBlock in interface AddressSegmentSeries
    
    Specified by:
    
    toPrefixBlock in class Address
    
    Returns:
    
    the block of address series for the prefix length
  - toLinkLocalIPv6
```
public IPv6Address toLinkLocalIPv6()
```
    Converts to a link-local Ipv6 address. Any MAC prefix length is ignored. Other elements of this address section are incorporated into the conversion. This will provide the latter 4 segments of an IPv6 address, to be paired with the link-local IPv6 prefix of 4 segments.
    
    Returns:
  - toEUI64IPv6
```
public IPv6AddressSection toEUI64IPv6()
```
    Converts to an Ipv6 address section. Any MAC prefix length is ignored. Other elements of this address section are incorporated into the conversion. This will provide the latter 4 segments of an IPv6 address, to be paired with an IPv6 prefix of 4 segments.
    
    Returns:
  - isEUI64
```
public boolean isEUI64(boolean asMAC)
```
    Whether this section is consistent with an IPv6 EUI64 section, which means it came from an extended 8 byte address, and the corresponding segments in the middle match 0xff and 0xff/fe for MAC/not-MAC
    
    Parameters:
    
    asMAC -
    
    Returns:
  - toEUI64
```
public MACAddress toEUI64(boolean asMAC)
```
    Convert to IPv6 EUI-64 section http://standards.ieee.org/develop/regauth/tut/eui64.pdf
    
    Parameters:
    
    asMAC - if true, this address is considered MAC and the EUI-64 is extended using ff-ff, otherwise this address is considered EUI-48 and extended using ff-fe Note that IPv6 treats MAC as EUI-48 and extends MAC to IPv6 addresses using ff-fe
    
    Returns:
  - replace
```
public MACAddress replace(int startIndex,
                          int endIndex,
                          MACAddress replacement,
                          int replacementIndex)
```
    Replaces segments starting from startIndex and ending before endIndex with the same number of segments starting at replacementStartIndex from the replacement section
    
    Parameters:
    
    startIndex -
    
    endIndex -
    
    replacement -
    
    replacementIndex -
    
    Returns:
    
    Throws:
    
    IndexOutOfBoundsException
  - replace
```
public MACAddress replace(int startIndex,
                          MACAddressSection replacement)
```
    Replaces segments starting from startIndex with as many segments as possible from the replacement section
    
    Parameters:
    
    startIndex -
    
    replacement -
    
    Returns:
    
    Throws:
    
    IndexOutOfBoundsException
  - getDottedAddress
```
public AddressDivisionGrouping getDottedAddress()
```
  - toAddressString
```
public MACAddressString toAddressString()
```
    Description copied from class: Address
    
    Returns a host identifier string representation for this address, which will be already validated.
    
    Overrides:
    
    toAddressString in class Address
    
    Returns:
  - toNormalizedString
```
public String toNormalizedString(AddressDivisionGrouping.StringOptions stringOptions)
```
  - toDottedString
```
public String toDottedString()
                      throws IncompatibleAddressException
```
    Throws:
    
    IncompatibleAddressException
  - toDashedString
```
public String toDashedString()
```
  - toColonDelimitedString
```
public String toColonDelimitedString()
```
  - toSpaceDelimitedString
```
public String toSpaceDelimitedString()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Address
  - isUnicast
```
public boolean isUnicast()
```
  - isMulticast
```
public boolean isMulticast()
```
    Multicast MAC addresses have the least significant bit of the first octet set to 1.
    
    Specified by:
    
    isMulticast in class Address
    
    See Also:
    
    InetAddress.isMulticastAddress()
  - isUniversal
```
public boolean isUniversal()
```
    Universal MAC addresses have second the least significant bit of the first octet set to 0.
  - isLocal
```
public boolean isLocal()
```
    Local MAC addresses have the second least significant bit of the first octet set to 1.
    
    Specified by:
    
    isLocal in class Address
    
    Returns:

Class MACAddress

Nested Class Summary

Nested classes/interfaces inherited from class inet.ipaddr.Address

Field Summary

Fields inherited from class inet.ipaddr.Address

Constructor Summary

Method Summary

Methods inherited from class inet.ipaddr.Address

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface inet.ipaddr.AddressSegmentSeries

Methods inherited from interface inet.ipaddr.format.AddressDivisionSeries

Methods inherited from interface inet.ipaddr.format.AddressComponentRange

Methods inherited from interface inet.ipaddr.format.AddressItem

Field Detail

COLON_SEGMENT_SEPARATOR

DASH_SEGMENT_SEPARATOR

SPACE_SEGMENT_SEPARATOR

DOTTED_SEGMENT_SEPARATOR

DASHED_SEGMENT_RANGE_SEPARATOR

DASHED_SEGMENT_RANGE_SEPARATOR_STR

BITS_PER_SEGMENT

BYTES_PER_SEGMENT

MEDIA_ACCESS_CONTROL_SEGMENT_COUNT

MEDIA_ACCESS_CONTROL_BIT_COUNT

MEDIA_ACCESS_CONTROL_DOTTED_SEGMENT_COUNT

MEDIA_ACCESS_CONTROL_DOTTED_64_SEGMENT_COUNT

MEDIA_ACCESS_CONTROL_DOTTED_BITS_PER_SEGMENT

MEDIA_ACCESS_CONTROL_SINGLE_DASHED_SEGMENT_COUNT

EXTENDED_UNIQUE_IDENTIFIER_48_SEGMENT_COUNT

EXTENDED_UNIQUE_IDENTIFIER_64_SEGMENT_COUNT

EXTENDED_UNIQUE_IDENTIFIER_48_BIT_COUNT

EXTENDED_UNIQUE_IDENTIFIER_64_BIT_COUNT

DEFAULT_TEXTUAL_RADIX

MAX_VALUE_PER_SEGMENT

MAX_VALUE_PER_DOTTED_SEGMENT

ORGANIZATIONAL_UNIQUE_IDENTIFIER_SEGMENT_COUNT

ORGANIZATIONAL_UNIQUE_IDENTIFIER_BIT_COUNT

Constructor Detail

MACAddress

MACAddress

MACAddress

MACAddress

MACAddress

MACAddress

MACAddress

MACAddress

MACAddress

MACAddress

Method Detail

enumerate

getNetwork

getIPv6Network

getAddressCreator

isExtended

isMACAddress

toMACAddress

isAllAddresses

getSection

getDivision

getSegment

getSegments

maxSegmentValue

getMaxSegmentValue

getByteCount

getBitCount

getBytesPerSegment

getBitsPerSegment

getIterable

iterator

spliterator

stream

prefixBlockIterator

prefixBlockSpliterator

prefixBlockStream

prefixIterator

prefixSpliterator

prefixStream

segmentsIterator

segmentsSpliterator