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

public abstract Class OneArgumentOptionHandler<T>

extends OptionHandler<T>
Class Inheritance
Known Direct Subclasses
org.kohsuke.args4j.spi.PathOptionHandler, org.kohsuke.args4j.spi.ShortOptionHandler, org.kohsuke.args4j.spi.UuidOptionHandler, org.kohsuke.args4j.spi.ByteOptionHandler, org.kohsuke.args4j.spi.CharOptionHandler, org.kohsuke.args4j.spi.DoubleOptionHandler, org.kohsuke.args4j.spi.FileOptionHandler, org.kohsuke.args4j.spi.FloatOptionHandler, org.kohsuke.args4j.spi.InetAddressOptionHandler, org.kohsuke.args4j.spi.IntOptionHandler, org.kohsuke.args4j.spi.LongOptionHandler
Type Parameters
<T>
Type of the Setter-class
Imports
org.kohsuke.args4j.CmdLineException, .CmdLineParser, .OptionDef
OptionHandler which handles an option with exactly one argument, like "-foo bar".
Author
Jan Materne
Since
2.0.9

Field Summary

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

Constructor Summary

AccessConstructor and Description
public
OneArgumentOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> 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.

protected abstract T

Returns:

the parsed value
parse(String
String value to parse
argument)

Parses a string to a real value of Type <T>.

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

Constructor Detail

OneArgumentOptionHandlerback to summary
public OneArgumentOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> 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
parseback to summary
protected abstract T parse(String argument) throws NumberFormatException, CmdLineException

Parses a string to a real value of Type <T>.

Parameters
argument:String

String value to parse

Returns:T

the parsed value

Exceptions
NumberFormatException:
if parsing is not possible
CmdLineException:
if the parsing encounters a failure that should be reported to the user.
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