Package org.plumelib.options

package org.plumelib.options

Command-line option processing for Java.

The Options class:

• parses command-line options and sets fields in your program accordingly,
• creates usage messages (such as printed by a `--help` option), and
• creates documentation suitable for a manual or manpage.

Thus, the programmer is freed from writing duplicative, boilerplate code. The user documentation is automatically generated and never gets out of sync with the rest of the program.

The programmer does not have to write any code, only declare and document variables. For each field that you want to set from a command-line argument, you write Javadoc and an @Option annotation. Then, the field is automatically set from a command-line option of the same name, and usage messages and printed documentation are generated automatically.

Class	Description
Option	Indicates that the annotated field is set via a command-line option.
OptionGroup	Indicates which @Option-annotated fields are part of an option group — a related set of user-visible features.
Options	The Options class: parses command-line options and sets fields in your program accordingly, creates usage messages (such as printed by a --help option), and creates documentation suitable for a manual or manpage.
Options.ArgException	Indicates an exception encountered during argument processing.
OptionsDoclet	Generates HTML documentation of command-line options, for use in a manual or in a Javadoc class comment.
Unpublicized	Indicates a field that can be set by a command-line option, but that command-line option is unpublicized: it is not included in the usage message.