A C E G J L O P S T U V W 

A

add(CharSequence) - Method in class org.plumelib.options.StringBuilderDelimited
 
append(String) - Method in class org.plumelib.options.StringBuilderDelimited
Deprecated.
Use #add(CharSequence)
append(Object) - Method in class org.plumelib.options.StringBuilderDelimited
Deprecated.
Use #add(CharSequence)
append(char) - Method in class org.plumelib.options.StringBuilderDelimited
Deprecated.
Use #add(CharSequence)
append(CharSequence) - Method in class org.plumelib.options.StringBuilderDelimited
Deprecated.
Use #add(CharSequence)
append(CharSequence, int, int) - Method in class org.plumelib.options.StringBuilderDelimited
Deprecated.
Use #add(CharSequence)

C

charAt(int) - Method in class org.plumelib.options.StringBuilderDelimited
Deprecated.
Not supported by StringJoiner which will supersede this

E

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

G

get_options_str() - Method in class org.plumelib.options.Options
Returns a string containing all of the options that were set and their arguments.
getFormatJavadoc() - Method in class org.plumelib.options.OptionsDoclet
 
getUseSingleDash() - Method in class org.plumelib.options.OptionsDoclet
 

J

javadocToHtml(Doc) - Static method in class org.plumelib.options.OptionsDoclet
Replace the @link tags and block @see tags in a Javadoc comment with sensible, non-hyperlinked HTML.

L

length() - Method in class org.plumelib.options.StringBuilderDelimited
 

O

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.

P

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().

S

setFormatJavadoc(boolean) - Method in class org.plumelib.options.OptionsDoclet
 
setOptions(String[][]) - Method in class org.plumelib.options.OptionsDoclet
Set the options for this class based on command-line arguments given by RootDoc.options().
settings() - Method in class org.plumelib.options.Options
Returns a string containing the current setting for each option, in a 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 a format that can be parsed by Options.
setUseSingleDash(boolean) - Method in class org.plumelib.options.OptionsDoclet
 
sortedKeySet(Map<K, V>) - Static method in class org.plumelib.options.Options
Returns a sorted version of m.keySet().
split_lists - Static variable in class org.plumelib.options.Options
When true, an argument to a option of list type is split, on whitespace, into multiple arguments each of which is added to the list.
start(RootDoc) - Static method in class org.plumelib.options.OptionsDoclet
Entry point for the doclet.
StringBuilderDelimited - Class in org.plumelib.options
Like StringBuilder, but adds a delimiter between each pair of strings that are inserted into the Stringbuilder.
StringBuilderDelimited(String) - Constructor for class org.plumelib.options.StringBuilderDelimited
Create a new StringBuilderDelimited.
subSequence(int, int) - Method in class org.plumelib.options.StringBuilderDelimited
Deprecated.
Not supported by StringJoiner which will supersede this

T

toString() - Method in class org.plumelib.options.Options
Return a description of all of the known options.
toString() - Method in class org.plumelib.options.StringBuilderDelimited
 

U

Unpublicized - Annotation Type in org.plumelib.options
Used in conjunction with the @Option annotation to signal that the option should not be included in the usage message, unless an optional include_unpublicized argument is supplied to the usage message method and is true.
usage(String...) - Method in class org.plumelib.options.Options
Return the String containing the usage message for command-line options.
usage(boolean, String...) - Method in class org.plumelib.options.Options
Returns the String containing the usage message for command-line options.
usage_synopsis - Variable in class org.plumelib.options.Options
Synopsis of usage.
use_single_dash(boolean) - Method in class org.plumelib.options.Options
If true, long options (those derived from field names) will be parsed with a single dash prefix as in -longOption.

V

validOptions(String[][], DocErrorReporter) - Static method in class org.plumelib.options.OptionsDoclet
Tests the validity of command-line arguments passed to this doclet.

W

write() - Method in class org.plumelib.options.OptionsDoclet
Write the output of this doclet to the correct file.
A C E G J L O P S T U V W