|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kohsuke.args4j.spi.OptionHandler<T>
T
- The type of the field that this OptionHandler
works with.public abstract class OptionHandler<T>
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)
Field Summary | |
---|---|
OptionDef |
option
The annotation. |
CmdLineParser |
owner
The owner to which this handler belongs to. |
Setter<? super T> |
setter
Object to be used for setting value. |
Constructor Summary | |
---|---|
protected |
OptionHandler(CmdLineParser parser,
OptionDef option,
Setter<? super T> setter)
|
Method Summary | |
---|---|
abstract String |
getDefaultMetaVariable()
Gets the default meta variable name used to print the usage screen. |
String |
getMetaVariable(ResourceBundle rb)
|
String |
getNameAndMeta(ResourceBundle rb)
|
abstract int |
parseArguments(Parameters params)
Called if the option that this owner recognizes is found. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public final OptionDef option
public final Setter<? super T> setter
public final CmdLineParser owner
Constructor Detail |
---|
protected OptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> setter)
Method Detail |
---|
public abstract int parseArguments(Parameters params) throws CmdLineException
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.
CmdLineException
public abstract String getDefaultMetaVariable()
public final String getMetaVariable(ResourceBundle rb)
public final String getNameAndMeta(ResourceBundle rb)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |