Top Description Fields Constructors Methods
org.kohsuke.args4j.spi

public Class MacAddressOptionHandler

extends OptionHandler<byte[]>
Class Inheritance
Imports
org.kohsuke.args4j.CmdLineException, .CmdLineParser, .OptionDef
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

Inherited from org.kohsuke.args4j.spi.OptionHandler:
optionownersetter

Constructor Summary

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

Method Summary

Modifier and TypeMethod and Description
public String
getDefaultMetaVariable()

Implements abstract org.kohsuke.args4j.spi.OptionHandler.getDefaultMetaVariable.

Gets the default meta variable name used to print the usage screen.

public int
parseArguments(Parameters
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.
params)

Implements abstract org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Called if the option that this owner recognizes is found.

Inherited from org.kohsuke.args4j.spi.OptionHandler:
getMetaVariablegetNameAndMetagetNameAndMetaprintDefaultValue

Constructor Detail

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

Method Detail

getDefaultMetaVariableback to summary
public String getDefaultMetaVariable()

Implements abstract org.kohsuke.args4j.spi.OptionHandler.getDefaultMetaVariable.

Doc from org.kohsuke.args4j.spi.OptionHandler.getDefaultMetaVariable.

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.

Returns:String

null to hide a meta variable.

Annotations
@Override
parseArgumentsback to summary
public int parseArguments(Parameters params) throws CmdLineException

Implements abstract org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Doc from org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Called if the option that this owner recognizes is found.

Parameters
params:Parameters

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:int

The number of arguments consumed. (For example, returns 0 if this option doesn't take any parameters.)

Annotations
@Override
printback to summary
public String print(byte[] v)

Overrides org.kohsuke.args4j.spi.OptionHandler.print.

Doc from org.kohsuke.args4j.spi.OptionHandler.print.

The opposite of the parse operation. This method is used to print the usage screen.

Annotations
@Override