A B C D E F G I L M O P S V

A

ArgParseException - exception argparser.ArgParseException.

Exception class used by ArgParser when command line arguments contain an error.

ArgParseException(String) - Constructor for class argparser.ArgParseException

Creates a new ArgParseException with the given message.

ArgParseException(String, String) - Constructor for class argparser.ArgParseException

Creates a new ArgParseException from the given argument and message.

ArgParser - class argparser.ArgParser.

ArgParser is used to parse the command line arguments for a java application program.

ArgParser(String) - Constructor for class argparser.ArgParser

Creates an ArgParser with a synopsis string, and the default help options -help and -?.

ArgParser(String, boolean) - Constructor for class argparser.ArgParser

Creates an ArgParser with a synopsis string.

ArgParserTest - class argparser.ArgParserTest.

Testing class for the class ArgParser.

addOption(String, Object) - Method in class argparser.ArgParser

Adds a new option description to the parser.

argparser - package argparser

argparser is a package for parsing the command line arguments of a Java program; detailed documentation is supplied in the class documentation for ArgParser.

B

BooleanHolder - class argparser.BooleanHolder.

Wrapper class which ``holds'' a boolean value, enabling methods to return boolean values through arguments.

BooleanHolder() - Constructor for class argparser.BooleanHolder

Constructs a new BooleanHolder with an initial value of false.

BooleanHolder(boolean) - Constructor for class argparser.BooleanHolder

Constructs a new BooleanHolder with a specific initial value.

C

CharHolder - class argparser.CharHolder.

Wrapper class which ``holds'' a character value, enabling methods to return character values through arguments.

CharHolder() - Constructor for class argparser.CharHolder

Constructs a new CharHolder with an initial value of 0.

CharHolder(char) - Constructor for class argparser.CharHolder

Constructs a new CharHolder with a specific initial value.

D

DoubleHolder - class argparser.DoubleHolder.

Wrapper class which ``holds'' a double value, enabling methods to return double values through arguments.

DoubleHolder() - Constructor for class argparser.DoubleHolder

Constructs a new DoubleHolder with an initial value of 0.

DoubleHolder(double) - Constructor for class argparser.DoubleHolder

Constructs a new DoubleHolder with a specific initial value.

E

EXIT_ON_ERROR - Static variable in class argparser.ArgParser

Indicates that the program should exit with an appropriate message in the event of an erroneous or malformed argument.

EXIT_ON_UNMATCHED - Static variable in class argparser.ArgParser

Indicates that the program should exit with an appropriate message in the event of an unmatched argument.

F

FloatHolder - class argparser.FloatHolder.

Wrapper class which ``holds'' a float value, enabling methods to return float values through arguments.

FloatHolder() - Constructor for class argparser.FloatHolder

Constructs a new FloatHolder with an initial value of 0.

FloatHolder(float) - Constructor for class argparser.FloatHolder

Constructs a new FloatHolder with a specific initial value.

G

getDefaultPrintStream() - Method in class argparser.ArgParser

Returns the default print stream used for outputting help and error information.

getErrorMessage() - Method in class argparser.ArgParser

Returns the parser's error message.

getHelpIndentation() - Method in class argparser.ArgParser

Gets the indentation used by getHelpMessage.

getHelpMessage() - Method in class argparser.ArgParser

Returns a string describing the allowed options in detail.

getHelpOptionsEnabled() - Method in class argparser.ArgParser

Indicates whether or not help options are enabled.

getSynopsisString() - Method in class argparser.ArgParser

Returns the synopsis string used by the parser.

getUnmatchedArgument() - Method in class argparser.ArgParser

Returns the value of an unmatched argument discovered matchArg or matchAllArgs.

getValidConversionCodes() - Static method in class argparser.ArgParser

Returns a string containing the valid conversion codes.

I

IntHolder - class argparser.IntHolder.

Wrapper class which ``holds'' an integer value, enabling methods to return integer values through arguments.

IntHolder() - Constructor for class argparser.IntHolder

Constructs a new IntHolder with an initial value of 0.

IntHolder(int) - Constructor for class argparser.IntHolder

Constructs a new IntHolder with a specific initial value.

L

LongHolder - class argparser.LongHolder.

Wrapper class which ``holds'' a long value, enabling methods to return long values through arguments.

LongHolder() - Constructor for class argparser.LongHolder

Constructs a new LongHolder with an initial value of 0.

LongHolder(long) - Constructor for class argparser.LongHolder

Constructs a new LongHolder with a specific initial value.

M

main(String[]) - Static method in class argparser.ArgParserTest

Runs a set of tests to verify correct operation of the ArgParser class.

main(String[]) - Static method in class argparser.SimpleExample

Run this to invoke command line parsing.

matchAllArgs(String[]) - Method in class argparser.ArgParser

Matches arguments within an argument list.

matchAllArgs(String[], int, int) - Method in class argparser.ArgParser

Matches arguments within an argument list and returns those which were not matched.

matchArg(String[], int) - Method in class argparser.ArgParser

Matches one option starting at a specified location in an argument list.

O

ObjectHolder - class argparser.ObjectHolder.

Wrapper class which ``holds'' an Object reference, enabling methods to return Object references through arguments.

ObjectHolder() - Constructor for class argparser.ObjectHolder

Constructs a new ObjectHolder with an initial value of null.

ObjectHolder(Object) - Constructor for class argparser.ObjectHolder

Constructs a new ObjectHolder with a specific initial value.

P

prependArgs(Reader, String[]) - Static method in class argparser.ArgParser

Reads in a set of strings from a reader and prepends them to an argument list.

prependArgs(File, String[]) - Static method in class argparser.ArgParser

Reads in a set of strings from a file and prepends them to an argument list.

printErrorAndExit(String) - Method in class argparser.ArgParser

Prints an error message, along with a pointer to help options, if available, and causes the program to exit with code 1.

S

SimpleExample - class argparser.SimpleExample.

Gives a very simple example of the use of ArgParser.

SimpleExample() - Constructor for class argparser.SimpleExample

StringHolder - class argparser.StringHolder.

Wrapper class which ``holds'' a String reference, enabling methods to return String references through arguments.

StringHolder() - Constructor for class argparser.StringHolder

Constructs a new StringHolder with an initial value of null.

StringHolder(String) - Constructor for class argparser.StringHolder

Constructs a new StringHolder with a specific initial value.

setDefaultPrintStream(PrintStream) - Method in class argparser.ArgParser

Sets the default print stream used for outputting help and error information.

setHelpIndentation(int) - Method in class argparser.ArgParser

Sets the indentation used by getHelpMessage.

setHelpOptionsEnabled(boolean) - Method in class argparser.ArgParser

Enables or disables help options.

setSynopsisString(String) - Method in class argparser.ArgParser

Sets the synopsis string used by the parser.

V

value - Variable in class argparser.BooleanHolder

Value of the boolean, set and examined by the application as needed.

value - Variable in class argparser.CharHolder

Value of the character, set and examined by the application as needed.

value - Variable in class argparser.DoubleHolder

Value of the double, set and examined by the application as needed.

value - Variable in class argparser.FloatHolder

Value of the float, set and examined by the application as needed.

value - Variable in class argparser.IntHolder

Value of the integer, set and examined by the application as needed.

value - Variable in class argparser.LongHolder

Value of the long, set and examined by the application as needed.

value - Variable in class argparser.ObjectHolder

Value of the Object reference, set and examined by the application as needed.

value - Variable in class argparser.StringHolder

Value of the String reference, set and examined by the application as needed.

A B C D E F G I L M O P S V