args4j 2.37 · org.kohsuke.args4j.spi · APIdia, the JavaDoc alternative

Modifier and Type	Interface and Description
public interface	Getter<T> Interface that can be instantiated to get default values.
public interface	Parameters List of arguments.
public interface	Setter<T> Abstraction of the value setter.

Modifier and Type	Annotation and Description
public @interface	SubCommand Specifies a single sub-command.
public @interface	SubCommands Collection of `SubCommand`s that define possible sub-commands.

Class Summary

Modifier and Type	Class and Description
public abstract class	AnnotationImpl Base class for the @Option and @Argument implementation classes.
public class	ArgumentImpl Implementation of @Argument so we can instantiate it.
pack-priv class	ArrayFieldSetter `Setter` that allows multiple values to be stored into one array field.
public class	BooleanOptionHandler Boolean `OptionHandler`.
public class	ByteOptionHandler `Byte` `OptionHandler` `OneArgumentOptionHandler`
public class	CharOptionHandler `Character` `OptionHandler` `OneArgumentOptionHandler`
public class	ConfigElement The ConfigElement is an `<option>` or `<argument>` tag in the xml configuration file.
public abstract 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.
public class	DoubleOptionHandler `Double` `OptionHandler`.
public class	EnumOptionHandler<T extends Enum<T>> `Enum` `OptionHandler`.
public class	ExplicitBooleanOptionHandler Boolean `OptionHandler` that (unlike the standard `BooleanOptionHandler` allows values to be set to false explicitly (using e.g. '-myOpt false') rather than only returning false when the option is omitted.
public class	FieldSetter `Setter` that sets to a `Field`.
public class	FileOptionHandler `File` `OptionHandler`.
public class	FloatOptionHandler `Float` `OptionHandler` `OneArgumentOptionHandler`
public class	InetAddressOptionHandler `InetAddress` `OptionHandler`.
public class	IntOptionHandler `Integer` `OptionHandler`.
public class	LongOptionHandler `Long` `OptionHandler` `OneArgumentOptionHandler`
public class	MacAddressOptionHandler `OptionHandler` that parses MAC address to byte[] of length 6.
public class	MapOptionHandler Parses options into a `Map`.
public class	MethodSetter `Setter` that sets to a `Method`.
public class	MultiFileOptionHandler Takes a classpath like option ("-cp a.jar;b.jar;c") and maps them to a collection of `File`.
public class	MultiPathOptionHandler Takes a classpath like option ("-cp a.jar;b.jar;c") and maps them to a collection of `Path`.
pack-priv class	MultiValueFieldSetter `Setter` that sets multiple values to a collection `Field`.
public abstract class	OneArgumentOptionHandler< Type of the Setter-class T> OptionHandler which handles an option with exactly one argument, like "-foo bar".
public abstract class	OptionHandler< The `component` type of the field that this `OptionHandler` works with. When I say "component", I mean a field that can hold multiple values (such as `Collection` or array). This should refer to its component time. `Setter` implementations abstract away multi-value-ness by allowing `OptionHandler` to invoke its `Setter#addValue(Object)` multiple times. T> Code that parses operands of an option into Java.
public class	OptionImpl Implementation of @Option so we can instantiate it.
public class	PathOptionHandler Takes a single argument to the option and maps that to `Path`.
public class	PatternOptionHandler A regex option handler.
public class	RestOfArgumentsHandler Eagerly grabs all the arguments.
public class	Setters Factory of `Setter`s.
public class	ShortOptionHandler `Short` `OptionHandler` `OneArgumentOptionHandler`
public class	StopOptionHandler `OptionHandler` for the option terminator `--`.
public class	StringArrayOptionHandler An `OptionHandler` for greedily mapping a list of tokens into a collection of `String`s (such as `String[]`, `List<String>`, etc.).
public class	StringOptionHandler String `OptionHandler`.
public class	SubCommandHandler `OptionHandler` used with `Argument` for parsing typical "sub-command" pattern.
public class	URIOptionHandler `URI` `OptionHandler`.
public class	URLOptionHandler `URL` `OptionHandler`.
public class	UuidOptionHandler `UUID` `OptionHandler`.

Package org.kohsuke.args4j.spi

Interface Summary

Annotation Summary

Class Summary

Enum Summary