Index (org.rwtodd.args 1.0.0 API)

A B C D E F G H I N O P S V
All Classes and Interfaces|All Packages|Serialized Form

A

AccumulatingParam - Class in org.rwtodd.args: A Param that counts the number of times it is seen.
AccumulatingParam(Collection<String>, int, String) - Constructor for class org.rwtodd.args.AccumulatingParam
AccumulatingParam(Collection<String>, String) - Constructor for class org.rwtodd.args.AccumulatingParam
addHelp(PrintStream) - Method in class org.rwtodd.args.BasicNoArgParam
addHelp(PrintStream) - Method in class org.rwtodd.args.BasicOneArgParam
addHelp(PrintStream) - Method in class org.rwtodd.args.EnumParam: adds help for this parameter to the given stream.
addHelp(PrintStream) - Method in interface org.rwtodd.args.Param: adds help for this parameter to the given stream.
addToMap(Map<String, Param>) - Method in class org.rwtodd.args.BasicNoArgParam
addToMap(Map<String, Param>) - Method in class org.rwtodd.args.BasicOneArgParam
addToMap(Map<String, Param>) - Method in class org.rwtodd.args.EnumParam: Add the parameter's names to a Map<String,Param>.
addToMap(Map<String, Param>) - Method in interface org.rwtodd.args.Param: Add the parameter's names to a Map<String,Param>.
arg - Variable in class org.rwtodd.args.BasicOneArgParam
ArgParserException - Exception Class in org.rwtodd.args: An exceptional situation from the command-line parser.
ArgParserException(String) - Constructor for exception class org.rwtodd.args.ArgParserException: Construct an ArgParserException.
ArgParserException(String, Throwable) - Constructor for exception class org.rwtodd.args.ArgParserException: Construct an ArgParserException.

B

BasicNoArgParam<T> - Class in org.rwtodd.args
BasicNoArgParam(Collection<String>, T, String) - Constructor for class org.rwtodd.args.BasicNoArgParam
BasicOneArgParam<T> - Class in org.rwtodd.args: A base class for a typical 1-argument parameter.
BasicOneArgParam(Collection<String>, T, String) - Constructor for class org.rwtodd.args.BasicOneArgParam: Construct a parameter.
BoundedIntParam - Class in org.rwtodd.args
BoundedIntParam(Collection<String>, Integer, int, int, String) - Constructor for class org.rwtodd.args.BoundedIntParam

C

ClampedIntParam - Class in org.rwtodd.args
ClampedIntParam(Collection<String>, Integer, int, int, String) - Constructor for class org.rwtodd.args.ClampedIntParam
convertArg(String, String) - Method in class org.rwtodd.args.BasicOneArgParam: A conversion method to get a T from a string.
convertArg(String, String) - Method in class org.rwtodd.args.DoubleParam
convertArg(String, String) - Method in class org.rwtodd.args.ExistingDirectoryParam
convertArg(String, String) - Method in class org.rwtodd.args.ExistingFileParam
convertArg(String, String) - Method in class org.rwtodd.args.IntListParam
convertArg(String, String) - Method in class org.rwtodd.args.IntParam
convertArg(String, String) - Method in class org.rwtodd.args.StringParam

D

DoubleParam - Class in org.rwtodd.args: DoubleParam is a Param that accepts double arguments.
DoubleParam(Collection<String>, Double, String) - Constructor for class org.rwtodd.args.DoubleParam
DoubleParam(Collection<String>, String) - Constructor for class org.rwtodd.args.DoubleParam

E

EnumParam<T extends Enum<T>> - Class in org.rwtodd.args: A parameter which gives options based on enum values.
EnumParam(Class<T>, String) - Constructor for class org.rwtodd.args.EnumParam: Create the EnumParam without a default (it will be null)
EnumParam(Class<T>, T, String) - Constructor for class org.rwtodd.args.EnumParam
ExistingDirectoryParam - Class in org.rwtodd.args: A param that takes expects an existing file on the filesystem
ExistingDirectoryParam(Collection<String>, String) - Constructor for class org.rwtodd.args.ExistingDirectoryParam
ExistingDirectoryParam(Collection<String>, Path, String) - Constructor for class org.rwtodd.args.ExistingDirectoryParam
ExistingFileParam - Class in org.rwtodd.args: A param that takes expects an existing file on the filesystem.
ExistingFileParam(Collection<String>, String) - Constructor for class org.rwtodd.args.ExistingFileParam
ExistingFileParam(Collection<String>, Path, String) - Constructor for class org.rwtodd.args.ExistingFileParam

F

FlagParam - Class in org.rwtodd.args: Represents a boolean flag, which takes no arguments, turns true when provided.
FlagParam(Collection<String>, String) - Constructor for class org.rwtodd.args.FlagParam
formatNames(Collection<String>) - Static method in interface org.rwtodd.args.Param: A helper function to format a list of parameter names.
formatTypicalHelp(PrintStream, String, String) - Static method in interface org.rwtodd.args.Param: A helper function to format a typical parameter.

G

getValue() - Method in class org.rwtodd.args.BasicNoArgParam
getValue() - Method in class org.rwtodd.args.BasicOneArgParam: Fetch the value stored by this parameter.
getValue() - Method in class org.rwtodd.args.EnumParam

H

helpText - Variable in class org.rwtodd.args.BasicNoArgParam
helpText - Variable in class org.rwtodd.args.BasicOneArgParam

I

IntListParam - Class in org.rwtodd.args: A parameter type that accepts lists of integers.
IntListParam(Collection<String>, String) - Constructor for class org.rwtodd.args.IntListParam
IntListParam(Collection<String>, IntStream, String) - Constructor for class org.rwtodd.args.IntListParam
IntParam - Class in org.rwtodd.args: IntParam is a Param that accepts integer arguments.
IntParam(Collection<String>, Integer, String) - Constructor for class org.rwtodd.args.IntParam
IntParam(Collection<String>, String) - Constructor for class org.rwtodd.args.IntParam

N

NoArgParam - Interface in org.rwtodd.args: An interface for a parameter that doesn't take arguments.

O

OneArgParam - Interface in org.rwtodd.args: An interface for parameters that take an argument from the command line.
org.rwtodd.args - package org.rwtodd.args

P

Param - Interface in org.rwtodd.args: Interface for command-line parameter specs.
paramNames - Variable in class org.rwtodd.args.BasicNoArgParam
paramNames - Variable in class org.rwtodd.args.BasicOneArgParam
parse(String...) - Method in class org.rwtodd.args.Parser: parses the given args, and returns any elements that don't appear to be params in an array.
Parser - Class in org.rwtodd.args: Parses command-line arguments against given Params.
Parser(Param...) - Constructor for class org.rwtodd.args.Parser: Construct a command-line parser from a set of Param objects.
printHelpText(PrintStream) - Method in class org.rwtodd.args.Parser: Print help text for each parameter given to us by the user.
process(String) - Method in class org.rwtodd.args.AccumulatingParam
process(String) - Method in class org.rwtodd.args.EnumParam
process(String) - Method in class org.rwtodd.args.FlagParam
process(String) - Method in interface org.rwtodd.args.NoArgParam: Process a parameter found on the command-line.
process(String, String) - Method in class org.rwtodd.args.BasicOneArgParam
process(String, String) - Method in interface org.rwtodd.args.OneArgParam: Process an parameter with its argument.

S

StringParam - Class in org.rwtodd.args
StringParam(Collection<String>, String) - Constructor for class org.rwtodd.args.StringParam
StringParam(Collection<String>, String, String) - Constructor for class org.rwtodd.args.StringParam

V

validate(String, Integer) - Method in class org.rwtodd.args.BoundedIntParam
validate(String, Integer) - Method in class org.rwtodd.args.ClampedIntParam
validate(String, T) - Method in class org.rwtodd.args.BasicOneArgParam: A validation method which subclasses can override to restrict the valid values of the argument.

A B C D E F G H I N O P S V
All Classes and Interfaces|All Packages|Serialized Form