Package org.kohsuke.args4j.spi
Class EnumOptionHandler<T extends Enum<T>>
- java.lang.Object
-
- org.kohsuke.args4j.spi.OptionHandler<T>
-
- org.kohsuke.args4j.spi.EnumOptionHandler<T>
-
public class EnumOptionHandler<T extends Enum<T>> extends OptionHandler<T>
- Author:
- Kohsuke Kawaguchi
-
-
Field Summary
-
Fields inherited from class org.kohsuke.args4j.spi.OptionHandler
option, owner, setter
-
-
Constructor Summary
Constructors Constructor Description EnumOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> setter, Class<T> enumType)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDefaultMetaVariable()
Gets the default meta variable name used to print the usage screen.String
getMetaVariable(ResourceBundle rb)
int
parseArguments(Parameters params)
Called if the option that this owner recognizes is found.-
Methods inherited from class org.kohsuke.args4j.spi.OptionHandler
getNameAndMeta, getNameAndMeta, print, printDefaultValue
-
-
-
-
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 classOptionHandler<T extends Enum<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
-
getDefaultMetaVariable
public 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 theResourceBundle
, if one was passed toCmdLineParser
.- Specified by:
getDefaultMetaVariable
in classOptionHandler<T extends Enum<T>>
- Returns:
null
to hide a meta variable.
-
getMetaVariable
public String getMetaVariable(ResourceBundle rb)
- Overrides:
getMetaVariable
in classOptionHandler<T extends Enum<T>>
-
-