Index (org.rwtodd.args 2.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

addHelp(PrintStream) - Method in class org.rwtodd.args.AppendingParam: adds help for this parameter to the given stream.
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.BoundedParam: adds help for this parameter to the given stream.
addHelp(PrintStream) - Method in class org.rwtodd.args.ClampedParam: adds help for this parameter to the given stream.
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.
addHelp(PrintStream) - Method in class org.rwtodd.args.ParamGroup: adds help for this parameter to the given stream.
addHelp(PrintStream) - Method in class org.rwtodd.args.SetRestrictedParam: adds help for this parameter to the given stream.
addToMap(Map<String, Param>) - Method in class org.rwtodd.args.AppendingParam: Add the parameter's names to a Map<String,Param>.
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.BoundedParam: Add the parameter's names to a Map<String,Param>.
addToMap(Map<String, Param>) - Method in class org.rwtodd.args.ClampedParam: Add the parameter's names to a Map<String,Param>.
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>.
addToMap(Map<String, Param>) - Method in class org.rwtodd.args.ParamGroup: Add the parameter's names to a Map<String,Param>.
addToMap(Map<String, Param>) - Method in class org.rwtodd.args.SetRestrictedParam: Add the parameter's names to a Map<String,Param>.
AppendingParam<T> - Class in org.rwtodd.args
AppendingParam(OneArgParam<T>) - Constructor for class org.rwtodd.args.AppendingParam: Construct a parameter that defaults to the empty list.
AppendingParam(OneArgParam<T>, List<T>) - Constructor for class org.rwtodd.args.AppendingParam: Construct a parameter.
arg - Variable in class org.rwtodd.args.AppendingParam
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(Iterable<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(Iterable<String>, T, String) - Constructor for class org.rwtodd.args.BasicOneArgParam: Construct a parameter.
BoundedParam<T extends Comparable<T>> - Class in org.rwtodd.args
BoundedParam(OneArgParam<T>, T, T) - Constructor for class org.rwtodd.args.BoundedParam
BoundedParam(OneArgParam<T>, T, T, BoundedParam.BoundType) - Constructor for class org.rwtodd.args.BoundedParam
BoundedParam.BoundType - Enum Class in org.rwtodd.args

C

CharParam - Class in org.rwtodd.args: CharParam is a Param that accepts single-character arguments.
CharParam(Iterable<String>, Character, String) - Constructor for class org.rwtodd.args.CharParam
CharParam(Iterable<String>, String) - Constructor for class org.rwtodd.args.CharParam
ClampedParam<T extends Comparable<T>> - Class in org.rwtodd.args
ClampedParam(OneArgParam<T>, T, T) - Constructor for class org.rwtodd.args.ClampedParam
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.CharParam
convertArg(String, String) - Method in class org.rwtodd.args.DateParam: A conversion method to get a LocalDate 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
CountingParam - Class in org.rwtodd.args: A Param that counts the number of times it is seen.
CountingParam(Iterable<String>, int, String) - Constructor for class org.rwtodd.args.CountingParam
CountingParam(Iterable<String>, String) - Constructor for class org.rwtodd.args.CountingParam

D

DateParam - Class in org.rwtodd.args
DateParam(Iterable<String>, String) - Constructor for class org.rwtodd.args.DateParam
DateParam(Iterable<String>, LocalDate, String) - Constructor for class org.rwtodd.args.DateParam
DecorativeParam - Interface in org.rwtodd.args: The base interface for Params that merely decorate the help text output, and do not add themselves to the Parser's lookup map.
delegate - Variable in class org.rwtodd.args.AppendingParam
DoubleParam - Class in org.rwtodd.args: DoubleParam is a Param that accepts double arguments.
DoubleParam(Iterable<String>, Double, String) - Constructor for class org.rwtodd.args.DoubleParam
DoubleParam(Iterable<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
Exclusive - Enum constant in enum class org.rwtodd.args.BoundedParam.BoundType
ExistingDirectoryParam - Class in org.rwtodd.args: A param that takes expects an existing file on the filesystem
ExistingDirectoryParam(Iterable<String>, String) - Constructor for class org.rwtodd.args.ExistingDirectoryParam
ExistingDirectoryParam(Iterable<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(Iterable<String>, String) - Constructor for class org.rwtodd.args.ExistingFileParam
ExistingFileParam(Iterable<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(Iterable<String>, String) - Constructor for class org.rwtodd.args.FlagParam
formatNames(Iterable<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.AppendingParam: gets the current value of the parameter
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.BoundedParam: gets the current value of the parameter
getValue() - Method in class org.rwtodd.args.ClampedParam: gets the current value of the parameter
getValue() - Method in class org.rwtodd.args.EnumParam
getValue() - Method in interface org.rwtodd.args.NoArgParam: gets the current value of the parameter
getValue() - Method in interface org.rwtodd.args.OneArgParam: gets the current value of the parameter
getValue() - Method in class org.rwtodd.args.SetRestrictedParam: gets the current value of the parameter

H

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

I

Inclusive - Enum constant in enum class org.rwtodd.args.BoundedParam.BoundType
IntListParam - Class in org.rwtodd.args: A parameter type that accepts lists of integers.
IntListParam(Iterable<String>, String) - Constructor for class org.rwtodd.args.IntListParam
IntListParam(Iterable<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(Iterable<String>, Integer, String) - Constructor for class org.rwtodd.args.IntParam
IntParam(Iterable<String>, String) - Constructor for class org.rwtodd.args.IntParam

N

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

O

OneArgParam<T> - 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.
ParamGroup - Class in org.rwtodd.args: This is a named group of Params for the purpose of organizing help text.
ParamGroup(String, Param...) - Constructor for class org.rwtodd.args.ParamGroup: Creates a ParamGroup.
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.
parse(String[], int) - 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.CountingParam
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.AppendingParam
process(String, String) - Method in class org.rwtodd.args.BasicOneArgParam
process(String, String) - Method in class org.rwtodd.args.BoundedParam: Process an parameter with its argument.
process(String, String) - Method in class org.rwtodd.args.ClampedParam: Process an parameter with its argument.
process(String, String) - Method in interface org.rwtodd.args.OneArgParam: Process an parameter with its argument.
process(String, String) - Method in class org.rwtodd.args.SetRestrictedParam: Process an parameter with its argument.

S

SetRestrictedParam<T> - Class in org.rwtodd.args
SetRestrictedParam(OneArgParam<T>, Iterable<T>) - Constructor for class org.rwtodd.args.SetRestrictedParam
StringParam - Class in org.rwtodd.args
StringParam(Iterable<String>, String) - Constructor for class org.rwtodd.args.StringParam
StringParam(Iterable<String>, String, String) - Constructor for class org.rwtodd.args.StringParam

V

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.
valueOf(String) - Static method in enum class org.rwtodd.args.BoundedParam.BoundType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.rwtodd.args.BoundedParam.BoundType: Returns an array containing the constants of this enum class, in the order they are declared.

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