Index (options 2.0.3 API)

A D E G I N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

aliases() - Element in annotation type org.plumelib.options.Option: Aliases for this option, which a user can use instead of the option's standard name.
ArgException(String) - Constructor for exception org.plumelib.options.Options.ArgException: Create an ArgException with the specified detail message.
ArgException(String, Object...) - Constructor for exception org.plumelib.options.Options.ArgException: Create an ArgException whose detail message is formed by formatting the given format string and arguments.

D

docCommentToHtml(DocCommentTree) - Static method in class org.plumelib.options.OptionsDoclet: Replace the @link tags and block @see tags in a Javadoc comment with HTML.

E

enableDebugLogging(boolean) - Method in class org.plumelib.options.Options: Enable or disable debug logging.

G

getBinaryName(TypeElement) - Static method in class org.plumelib.options.OptionsDoclet: Returns the binary name of the given type.
getFormatJavadoc() - Method in class org.plumelib.options.OptionsDoclet: Returns true if the output format is Javadoc, false if the output format is HTML.
getName() - Method in class org.plumelib.options.OptionsDoclet
getOptionsString() - Method in class org.plumelib.options.Options: Returns a string containing all of the options that were set and their arguments.
getSupportedOptions() - Method in class org.plumelib.options.OptionsDoclet
getSupportedSourceVersion() - Method in class org.plumelib.options.OptionsDoclet
getUseSingleDash() - Method in class org.plumelib.options.OptionsDoclet: Return true if using a single dash (as opposed to a double dash) for command-line options.

I

init(Locale, Reporter) - Method in class org.plumelib.options.OptionsDoclet
isTypeElement(Element) - Static method in class org.plumelib.options.OptionsDoclet: Returns true if the given element kind is a type, i.e., a class, enum, interface, or annotation type.

N

noDocDefault() - Element in annotation type org.plumelib.options.Option: If true, OptionsDoclet does not report the field's default value.

O

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.
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.
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() - Constructor for class org.plumelib.options.OptionsDoclet: Create an 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 one Option.
org.plumelib.options - package org.plumelib.options: Command-line option processing for Java.
output() - Method in class org.plumelib.options.OptionsDoclet: Get the final output of this doclet.

P

parse(boolean, String[]) - Method in class org.plumelib.options.Options: Sets option variables from the given command line; if any command-line argument is illegal, prints the usage message and terminates the program.
parse(String[]) - Method in class org.plumelib.options.Options: Sets option variables from the given command line.
parse(String, String[]) - Method in class org.plumelib.options.Options: Sets option variables from the given command line; if any command-line argument is illegal, prints the given message and terminates the program.
printUsage() - Method in class org.plumelib.options.Options: Prints, to standard output, usage information.
printUsage(PrintStream) - Method in class org.plumelib.options.Options: Prints usage information to the given PrintStream.
processJavadoc() - Method in class org.plumelib.options.OptionsDoclet: Adds Javadoc info to each option in options.getOptions().

R

run(DocletEnvironment) - Method in class org.plumelib.options.OptionsDoclet

S

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.
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: See Options.setUseSingleDash(boolean).
spaceSeparatedLists - Static variable in class org.plumelib.options.Options: Whether to treat arguments to lists as space-separated.

T

tokenize(String) - Static method in class org.plumelib.options.Options: Splits the argument string into an array of tokens (command-line flags and arguments), respecting single and double quotes.
toString() - Method in class org.plumelib.options.Options: Return a description of all of the known options.

U

unpublicized() - Element in annotation type org.plumelib.options.OptionGroup: Whether this option group is unpublicized.
Unpublicized - Annotation Type in org.plumelib.options: 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.
usage(boolean, String...) - Method in class org.plumelib.options.Options: Returns a usage message for command-line options.
usage(String...) - Method in class org.plumelib.options.Options: Returns a usage message for command-line options.
usageSynopsis - Variable in class org.plumelib.options.Options: Synopsis of usage.
useDashes - Variable in class org.plumelib.options.Options: In usage messages, use dashes (hyphens) to split words in option names.
useSingleDash - Variable in class org.plumelib.options.Options: When true, long options take the form -longOption with a single dash, rather than the default --longOption with two dashes.

V

value() - Element in annotation type org.plumelib.options.Option: A string that describes the option.
value() - Element in annotation type org.plumelib.options.OptionGroup: Name of this option group.

W

write() - Method in class org.plumelib.options.OptionsDoclet: Write the output of this doclet to the correct file.

A D E G I N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form