Package org.kohsuke.args4j.spi

## Class MacAddressOptionHandler

- java.lang.Object
- - org.kohsuke.args4j.spi.OptionHandler<byte[]>
  - - org.kohsuke.args4j.spi.MacAddressOptionHandler

    public class MacAddressOptionHandler
    extends OptionHandler<byte[]>

`OptionHandler` that parses MAC address to byte[] of length 6.

The string representation of a MAC address can be of different forms, e.g.

     XXXXXXXXXXXX
     XX XX XX XX XX XX
     XX-XX-XX-XX-XX-XX
     XX:XX:XX:XX:XX:XX

Author:
  Tobias Stolzmann

### Field Summary

### Fields inherited from class org.kohsuke.args4j.spi.OptionHandler

`option, owner, setter`

### Constructor Summary

Constructors
`MacAddressOptionHandler​(CmdLineParser parser, OptionDef option, Setter<? super byte[]> setter)`

### Method Summary

All Methods Instance Methods Concrete Methods
`java.lang.String` `getDefaultMetaVariable()` Gets the default meta variable name used to print the usage screen.
`int` `parseArguments​(Parameters params)` Called if the option that this owner recognizes is found.
`java.lang.String` `print​(byte[] v)` The opposite of the parse operation.

### Methods inherited from class org.kohsuke.args4j.spi.OptionHandler

`getMetaVariable, getNameAndMeta, getNameAndMeta, printDefaultValue`

### Methods inherited from class java.lang.Object

`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

### Constructor Detail

#### MacAddressOptionHandler

    public MacAddressOptionHandler​(CmdLineParser parser,
                                   OptionDef option,
                                   Setter<? super byte[]> setter)

### Method Detail

#### parseArguments

    public int parseArguments​(Parameters params)
                       throws CmdLineException

Description copied from class: `OptionHandler`
Called if the option that this owner recognizes is found.

Specified by:
  `parseArguments` in class `OptionHandler<byte[]>`
Parameters:
  `params` - The rest of the arguments. This method can use this object to access the arguments of the option if necessary. The object is valid only during the method call.
Returns:
  The number of arguments consumed. (For example, returns `0` if this option doesn't take any parameters.)
Throws:
  `CmdLineException`

#### getDefaultMetaVariable

    public java.lang.String getDefaultMetaVariable()

Description copied from class: `OptionHandler`
Gets the default meta variable name used to print the usage screen. The value returned by this method can be a reference in the `ResourceBundle`, if one was passed to `CmdLineParser`.

Specified by:
  `getDefaultMetaVariable` in class `OptionHandler<byte[]>`
Returns:
  `null` to hide a meta variable.

#### print

    public java.lang.String print​(byte[] v)

Description copied from class: `OptionHandler`
The opposite of the parse operation. This method is used to print the usage screen.

Overrides:
  `print` in class `OptionHandler<byte[]>`