Package | Description |
---|---|
org.kohsuke.args4j |
Core classes of the Args4J command line parser.
|
org.kohsuke.args4j.spi |
Classes for extending the behavior of args4j.
|
Modifier and Type | Field and Description |
---|---|
private OptionHandler |
CmdLineParser.currentOptionHandler |
Modifier and Type | Field and Description |
---|---|
private java.util.List<OptionHandler> |
CmdLineParser.arguments
Discovered
OptionHandler s for arguments. |
private java.lang.reflect.Constructor<? extends OptionHandler> |
OptionHandlerRegistry.DefaultConstructorHandlerFactory.cons |
(package private) static java.util.Comparator<OptionHandler> |
ParserProperties.DEFAULT_COMPARATOR |
private java.lang.Class<? extends OptionHandler> |
OptionDef.handler |
private java.util.List<OptionHandler> |
CmdLineParser.options
Discovered
OptionHandler s for options. |
private java.util.Comparator<OptionHandler> |
ParserProperties.optionSorter |
Modifier and Type | Method and Description |
---|---|
protected OptionHandler |
OptionHandlerRegistry.createOptionHandler(CmdLineParser parser,
OptionDef o,
Setter setter)
|
protected OptionHandler |
CmdLineParser.createOptionHandler(OptionDef o,
Setter setter)
|
private OptionHandler |
CmdLineParser.findOptionByName(java.lang.String name)
Finds a registered
OptionHandler by its name or its alias. |
private OptionHandler |
CmdLineParser.findOptionHandler(java.lang.String name) |
OptionHandler<?> |
OptionHandlerRegistry.OptionHandlerFactory.getHandler(CmdLineParser parser,
OptionDef o,
Setter setter)
Provide a handler instance to use.
|
OptionHandler<?> |
OptionHandlerRegistry.DefaultConstructorHandlerFactory.getHandler(CmdLineParser parser,
OptionDef o,
Setter setter) |
Modifier and Type | Method and Description |
---|---|
java.util.List<OptionHandler> |
CmdLineParser.getArguments()
Lists up all the defined arguments in the order.
|
private static java.lang.reflect.Constructor<? extends OptionHandler> |
OptionHandlerRegistry.getConstructor(java.lang.Class<? extends OptionHandler> handlerClass)
Finds the constructor for an option handler.
|
java.util.List<OptionHandler> |
CmdLineParser.getOptions()
Lists up all the defined options.
|
(package private) java.util.Comparator<OptionHandler> |
ParserProperties.getOptionSorter() |
java.lang.Class<? extends OptionHandler> |
OptionDef.handler() |
Modifier and Type | Method and Description |
---|---|
private java.lang.String |
CmdLineParser.createDefaultValuePart(OptionHandler handler) |
private int |
CmdLineParser.getPrefixLen(OptionHandler h,
java.util.ResourceBundle rb) |
protected void |
CmdLineParser.printOption(java.io.PrintWriter out,
OptionHandler handler,
int len,
java.util.ResourceBundle rb,
OptionHandlerFilter filter)
Prints usage information for a given option.
|
private void |
CmdLineParser.printSingleLineOption(java.io.PrintWriter pw,
OptionHandler h,
java.util.ResourceBundle rb) |
boolean |
OptionHandlerFilter.select(OptionHandler o) |
Modifier and Type | Method and Description |
---|---|
private void |
CmdLineParser.checkRequiredOptionsAndArguments(java.util.Set<OptionHandler> present) |
private static java.lang.reflect.Constructor<? extends OptionHandler> |
OptionHandlerRegistry.getConstructor(java.lang.Class<? extends OptionHandler> handlerClass)
Finds the constructor for an option handler.
|
private boolean |
CmdLineParser.isHandlerAllowOtherOptions(NamedOptionDef option,
java.util.Set<OptionHandler> present) |
private boolean |
CmdLineParser.isHandlerHasHisOptions(NamedOptionDef option,
java.util.Set<OptionHandler> present) |
void |
OptionHandlerRegistry.registerHandler(java.lang.Class valueType,
java.lang.Class<? extends OptionHandler> handlerClass)
Registers a user-defined
OptionHandler class with args4j. |
static void |
CmdLineParser.registerHandler(java.lang.Class valueType,
java.lang.Class<? extends OptionHandler> handlerClass)
Deprecated.
You should use
OptionHandlerRegistry.registerHandler(java.lang.Class, java.lang.Class) instead. |
ParserProperties |
ParserProperties.withOptionSorter(java.util.Comparator<OptionHandler> sorter)
Controls how options are sorted in the usage screen.
|
Constructor and Description |
---|
OptionDef(java.lang.String usage,
java.lang.String metaVar,
boolean required,
boolean help,
boolean hidden,
java.lang.Class<? extends OptionHandler> handler,
boolean multiValued) |
Modifier and Type | Class and Description |
---|---|
class |
BooleanOptionHandler
Boolean
OptionHandler . |
class |
ByteOptionHandler
|
class |
CharOptionHandler
|
class |
DelimitedOptionHandler<T>
Partial
OptionHandler implementation that takes a single value to the option,
which is then gets split into individual tokens using fixed delimiter. |
class |
DoubleOptionHandler
Double
OptionHandler . |
class |
EnumOptionHandler<T extends java.lang.Enum<T>>
Enum OptionHandler . |
class |
ExplicitBooleanOptionHandler
Boolean
OptionHandler that (unlike the standard BooleanOptionHandler
allows values to be set to false explicitly (using e.g. |
class |
FileOptionHandler
File OptionHandler . |
class |
FloatOptionHandler
|
class |
InetAddressOptionHandler
InetAddress OptionHandler . |
class |
IntOptionHandler
Integer
OptionHandler . |
class |
LongOptionHandler
|
class |
MacAddressOptionHandler
OptionHandler that parses MAC address to byte[] of length 6. |
class |
MapOptionHandler
Parses options into a
Map . |
class |
MultiFileOptionHandler
Takes a classpath like option ("-cp a.jar;b.jar;c") and maps them to a collection of
File . |
class |
MultiPathOptionHandler
Takes a classpath like option ("-cp a.jar;b.jar;c") and maps them to a collection of
Path . |
class |
OneArgumentOptionHandler<T>
OptionHandler which handles an option with exactly one argument, like "-foo bar".
|
class |
PathOptionHandler
Takes a single argument to the option and maps that to
Path . |
class |
PatternOptionHandler
A regex option handler.
|
class |
RestOfArgumentsHandler
Eagerly grabs all the arguments.
|
class |
ShortOptionHandler
|
class |
StopOptionHandler
OptionHandler for the option terminator --. |
class |
StringArrayOptionHandler
An
OptionHandler for greedily mapping a list of tokens into a collection of String s
(such as String[] , List<String> , etc.). |
class |
StringOptionHandler
String
OptionHandler . |
class |
SubCommandHandler
OptionHandler used with Argument for parsing typical "sub-command" pattern. |
class |
URIOptionHandler
URI OptionHandler . |
class |
URLOptionHandler
URL OptionHandler . |
class |
UuidOptionHandler
UUID OptionHandler . |
Modifier and Type | Field and Description |
---|---|
java.lang.Class<? extends OptionHandler> |
AnnotationImpl.handler |
Modifier and Type | Method and Description |
---|---|
java.lang.Class<? extends OptionHandler> |
AnnotationImpl.handler() |