Package org.kohsuke.args4j.spi
Class OneArgumentOptionHandler<T>
java.lang.Object
org.kohsuke.args4j.spi.OptionHandler<T>
org.kohsuke.args4j.spi.OneArgumentOptionHandler<T>
- Type Parameters:
T
- Type of the Setter-class
- Direct Known Subclasses:
ByteOptionHandler
,CharOptionHandler
,DoubleOptionHandler
,FileOptionHandler
,FloatOptionHandler
,InetAddressOptionHandler
,IntOptionHandler
,LongOptionHandler
,PathOptionHandler
,ShortOptionHandler
,UuidOptionHandler
OptionHandler which handles an option with exactly one argument, like "-foo bar".
- Since:
- 2.0.9
- Author:
- Jan Materne
-
Field Summary
Fields inherited from class org.kohsuke.args4j.spi.OptionHandler
option, owner, setter
-
Constructor Summary
ConstructorsConstructorDescriptionOneArgumentOptionHandler
(CmdLineParser parser, OptionDef option, Setter<? super T> setter) -
Method Summary
Modifier and TypeMethodDescriptionGets the default meta variable name used to print the usage screen.protected abstract T
Parses a string to a real value of Type <T>.int
parseArguments
(Parameters params) Called if the option that this owner recognizes is found.Methods inherited from class org.kohsuke.args4j.spi.OptionHandler
getMetaVariable, getNameAndMeta, getNameAndMeta, print, printDefaultValue
-
Constructor Details
-
OneArgumentOptionHandler
-
-
Method Details
-
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 theResourceBundle
, if one was passed toCmdLineParser
.- Specified by:
getDefaultMetaVariable
in classOptionHandler<T>
- Returns:
null
to hide a meta variable.
-
parseArguments
Description copied from class:OptionHandler
Called if the option that this owner recognizes is found.- Specified by:
parseArguments
in classOptionHandler<T>
- 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
-
parse
Parses a string to a real value of Type <T>.- Parameters:
argument
- String value to parse- Returns:
- the parsed value
- Throws:
NumberFormatException
- if parsing is not possibleCmdLineException
- if the parsing encounters a failure that should be reported to the user.
-