Package org.kohsuke.args4j.spi
Class OptionHandler<T>
- java.lang.Object
-
- org.kohsuke.args4j.spi.OptionHandler<T>
-
- Type Parameters:
T
- The type of the field that thisOptionHandler
works with.
- Direct Known Subclasses:
BooleanOptionHandler
,EnumOptionHandler
,FileOptionHandler
,MapOptionHandler
,OneArgumentOptionHandler
,StopOptionHandler
,StringOptionHandler
public abstract class OptionHandler<T> extends java.lang.Object
Code that parses operands of an option into Java.This class can be extended by application to support additional Java datatypes in option operands.
Implementation of this class needs to be registered to args4j by using
CmdLineParser.registerHandler(Class,Class)
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
OptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> setter)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract java.lang.String
getDefaultMetaVariable()
Gets the default meta variable name used to print the usage screen.java.lang.String
getMetaVariable(java.util.ResourceBundle rb)
java.lang.String
getNameAndMeta(java.util.ResourceBundle rb)
abstract int
parseArguments(Parameters params)
Called if the option that this owner recognizes is found.
-
-
-
Field Detail
-
option
public final OptionDef option
The annotation.
-
owner
public final CmdLineParser owner
The owner to which this handler belongs to.
-
-
Constructor Detail
-
OptionHandler
protected OptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> setter)
-
-
Method Detail
-
parseArguments
public abstract int parseArguments(Parameters params) throws CmdLineException
Called if the option that this owner recognizes is found.- 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, return 0 if this option doesn't take any parameter.
- Throws:
CmdLineException
-
getDefaultMetaVariable
public abstract java.lang.String getDefaultMetaVariable()
Gets the default meta variable name used to print the usage screen.- Returns:
- null to hide a meta variable.
-
getMetaVariable
public final java.lang.String getMetaVariable(java.util.ResourceBundle rb)
-
getNameAndMeta
public final java.lang.String getNameAndMeta(java.util.ResourceBundle rb)
-
-