- Option - Annotation Type in org.plumelib.options
-
Indicates that the annotated field is set via command-line option.
- OptionGroup - Annotation Type in org.plumelib.options
-
Used in conjunction with the @Option
annotation to indicate that the following
@Option
-annotated fields (including the one the @OptionGroup
annotation is
applied to) belong to the same option group.
- 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.
- 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.ArgException - Exception in org.plumelib.options
-
Indicates an exception encountered during argument processing.
- Options.ArgException(String) - Constructor for exception org.plumelib.options.Options.ArgException
-
- Options.ArgException(String, Object...) - Constructor for exception org.plumelib.options.Options.ArgException
-
- OptionsDoclet - Class in org.plumelib.options
-
Generates HTML documentation of command-line options.
- OptionsDoclet(RootDoc, Options) - Constructor for class org.plumelib.options.OptionsDoclet
-
- 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 an Option.
- org.plumelib.options - package org.plumelib.options
-
- output() - Method in class org.plumelib.options.OptionsDoclet
-
Get the final output of this doclet.
- parse(String[]) - Method in class org.plumelib.options.Options
-
Parses a command line and sets the options accordingly.
- parse(String) - Method in class org.plumelib.options.Options
-
Parses a command line and sets the options accordingly.
- parse_options_after_arg(boolean) - Method in class org.plumelib.options.Options
-
If true, Options will parse arguments even after a non-option command-line argument.
- parse_or_message(String, String[]) - Method in class org.plumelib.options.Options
-
Parses a command line and sets the options accordingly.
- parse_or_message(String, String) - Method in class org.plumelib.options.Options
-
Parses a command line and sets the options accordingly.
- parse_or_usage(String[]) - Method in class org.plumelib.options.Options
-
Parses a command line and sets the options accordingly.
- parse_or_usage(String) - Method in class org.plumelib.options.Options
-
Parses a command line and sets the options accordingly.
- print_usage(PrintStream) - Method in class org.plumelib.options.Options
-
Prints usage information.
- print_usage() - Method in class org.plumelib.options.Options
-
Prints, to standard output, usage information.
- print_usage(PrintStream, String) - Method in class org.plumelib.options.Options
-
Prints a message followed by indented usage information.
- print_usage(String) - Method in class org.plumelib.options.Options
-
Prints, to standard output, a message followed by usage information.
- print_usage(PrintStream, String, Object...) - Method in class org.plumelib.options.Options
-
Prints a message followed by usage information.
- print_usage(String, Object...) - Method in class org.plumelib.options.Options
-
Prints, to standard output, a message followed by usage information.
- processJavadoc() - Method in class org.plumelib.options.OptionsDoclet
-
Side-effects each option in options.getOptions()
.