- obj - Variable in class org.plumelib.options.Options.OptionInfo
-
Object containing the field.
- Option - Annotation Type in org.plumelib.options
-
Indicates that the annotated field is set via a command-line option.
- OptionGroup - Annotation Type in org.plumelib.options
-
Indicates which @Option
-annotated fields are part of an option group — a related
set of user-visible features.
- OptionGroupInfo(String, boolean) - Constructor for class org.plumelib.options.Options.OptionGroupInfo
-
Create a new option group.
- OptionGroupInfo(OptionGroup) - Constructor for class org.plumelib.options.Options.OptionGroupInfo
-
Create a copy of an option group.
- OptionInfo(Field, Option, Object, boolean) - Constructor for class org.plumelib.options.Options.OptionInfo
-
Create a new OptionInfo.
- optionLength(String) - Static method in class org.plumelib.options.OptionsDoclet
-
Given a command-line option of this doclet, returns the number of arguments you must specify on
the command line for the given option.
- optionList - Variable in class org.plumelib.options.Options.OptionGroupInfo
-
List of options that belong to this group.
- optionListToHtml(List<Options.OptionInfo>, int, int, int) - Method in class org.plumelib.options.OptionsDoclet
-
Get the HTML describing many options, formatted as an HTML list.
- Options - Class in org.plumelib.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(Object...) - Constructor for class org.plumelib.options.Options
-
Prepare for option processing.
- Options(String, Object...) - Constructor for class org.plumelib.options.Options
-
Prepare for option processing.
- options - Variable in class org.plumelib.options.Options
-
List of all of the defined options.
- options - Variable in class org.plumelib.options.OptionsDoclet
-
The command-line options.
- Options.ArgException - Exception in org.plumelib.options
-
Indicates an exception encountered during argument processing.
- Options.OptionGroupInfo - Class in org.plumelib.options
-
Information about an option group.
- Options.OptionInfo - Class in org.plumelib.options
-
Information about an option.
- Options.ParseResult - Class in org.plumelib.options
-
The result of parsing the argument to @Option
.
- OptionsDoclet - Class in org.plumelib.options
-
Generates HTML documentation of command-line options, for use in a manual or in a Javadoc class
comment.
- OptionsDoclet(RootDoc, Options) - Constructor for class org.plumelib.options.OptionsDoclet
-
Create an OptionsDoclet that documents the given options.
- optionsString - Variable in class org.plumelib.options.Options
-
All of the argument options as a single string.
- optionsToHtml(int) - Method in class org.plumelib.options.OptionsDoclet
-
Get the HTML documentation for the underlying Options instance.
- optionsToJavadoc(int, int) - Method in class org.plumelib.options.OptionsDoclet
-
Get the HTML documentation for the underlying Options instance, formatted as a Javadoc comment.
- optionToHtml(Options.OptionInfo, int) - Method in class org.plumelib.options.OptionsDoclet
-
Get the line of HTML describing one Option.
- org.plumelib.options - package org.plumelib.options
-
Command-line option processing for Java.
- outFile - Variable in class org.plumelib.options.OptionsDoclet
-
Destination for output.
- output() - Method in class org.plumelib.options.OptionsDoclet
-
Get the final output of this doclet.
- safeGetAnnotation(Field, Class<T>) - Static method in class org.plumelib.options.Options
-
Like Field.getAnnotation(java.lang.Class<T>)
, but returns null (and prints a warning) rather than throwing
an exception.
- serialVersionUID - Static variable in exception org.plumelib.options.Options.ArgException
-
- setArg(Options.OptionInfo, String, String) - Method in class org.plumelib.options.Options
-
Set the specified option to the value specified in argValue.
- setFormatJavadoc(boolean) - Method in class org.plumelib.options.OptionsDoclet
-
Supply true to set the output format to Javadoc, false to set the output format to HTML.
- setOptions(String[][]) - Method in class org.plumelib.options.OptionsDoclet
-
Set the underlying Options instance for this class based on command-line arguments given by
RootDoc.options().
- setParseAfterArg(boolean) - Method in class org.plumelib.options.Options
-
If true, Options will parse arguments even after a non-option command-line argument.
- settings() - Method in class org.plumelib.options.Options
-
Returns a string containing the current setting for each option, in command-line format that
can be parsed by Options.
- settings(boolean) - Method in class org.plumelib.options.Options
-
Returns a string containing the current setting for each option, in command-line format that
can be parsed by Options.
- setUseSingleDash(boolean) - Method in class org.plumelib.options.Options
-
If true, long options (those derived from field names) are expected with a single dash prefix
as in -long-option
rather than --long-option
.
- setUseSingleDash(boolean) - Method in class org.plumelib.options.OptionsDoclet
-
- shortName - Variable in class org.plumelib.options.Options.OptionInfo
-
Short (one-character) argument name.
- shortName - Variable in class org.plumelib.options.Options.ParseResult
-
The short name of an option, or null if none.
- sortedKeySet(Map<K, V>) - Static method in class org.plumelib.options.Options
-
Returns a sorted version of m.keySet().
- spaceSeparatedLists - Static variable in class org.plumelib.options.Options
-
Whether to treat arguments to lists as space-separated.
- start(RootDoc) - Static method in class org.plumelib.options.OptionsDoclet
-
Entry point for the doclet.
- startDelim - Variable in class org.plumelib.options.OptionsDoclet
-
Marker for start of options documentation.
- synopsis() - Method in class org.plumelib.options.Options.OptionInfo
-
Returns a short synopsis of the option in the form -s --long=<type>
.