Skip navigation links
A B C D E F G H I J L M N O P R S T U V W 

A

add(CharSequence) - Method in class org.plumelib.options.StringBuilderDelimited
 
aliases - Variable in class org.plumelib.options.Options.OptionInfo
Aliases for this option.
anyPublicized() - Method in class org.plumelib.options.Options.OptionGroupInfo
If false, this group of options does not contain any publicized options, so it will not be included in the default usage message.
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)
appendDelimiter() - Method in class org.plumelib.options.StringBuilderDelimited
 
ArgException(String) - Constructor for exception org.plumelib.options.Options.ArgException
 
ArgException(String, Object...) - Constructor for exception org.plumelib.options.Options.ArgException
 
argumentRequired() - Method in class org.plumelib.options.Options.OptionInfo
Return whether or not this option has a required argument.

B

baseType - Variable in class org.plumelib.options.Options.OptionInfo
Class type of this field.

C

charAt(int) - Method in class org.plumelib.options.StringBuilderDelimited
Deprecated.
Not supported by StringJoiner which will supersede this
constructor - Variable in class org.plumelib.options.Options.OptionInfo
Constructor that takes one String for the type.

D

debugEnabled - Variable in class org.plumelib.options.Options
 
defaultStr - Variable in class org.plumelib.options.Options.OptionInfo
Default value of the option as a string.
delegate - Variable in class org.plumelib.options.StringBuilderDelimited
The StringBuilder to which this delegates work.
delimiter - Variable in class org.plumelib.options.StringBuilderDelimited
The delimiter put between strings appended to this.
description - Variable in class org.plumelib.options.Options.OptionInfo
Argument description: the first line.
description - Variable in class org.plumelib.options.Options.ParseResult
 
docFile - Variable in class org.plumelib.options.OptionsDoclet
 

E

empty - Variable in class org.plumelib.options.StringBuilderDelimited
False iff some text has already been appended to this.
enableDebugLogging(boolean) - Method in class org.plumelib.options.Options
Enable or disable debug logging.
endDelim - Variable in class org.plumelib.options.OptionsDoclet
 
enumJdoc - Variable in class org.plumelib.options.Options.OptionInfo
Maps names of enum constants to their corresponding Javadoc.
eol - Static variable in class org.plumelib.options.OptionsDoclet
 

F

factory - Variable in class org.plumelib.options.Options.OptionInfo
Factory that takes a string (some classes don't have a string constructor) and always returns non-null.
factoryArg2 - Variable in class org.plumelib.options.Options.OptionInfo
The second argument to the factory; non-null if needed.
field - Variable in class org.plumelib.options.Options.OptionInfo
What variable the option sets.
formatJavadoc - Variable in class org.plumelib.options.OptionsDoclet
If true, then output format is Javadoc.
formatOptions(List<Options.OptionInfo>, int, boolean) - Method in class org.plumelib.options.Options
Format a list of options for use in generating usage messages.

G

getDeclaringClass() - Method in class org.plumelib.options.Options.OptionInfo
Returns the class that declares this option.
getEnumValue(Class<T>, String) - Method in class org.plumelib.options.Options
Behaves like Enum.valueOf(java.lang.Class<T>, java.lang.String), except that name is case-insensitive and hyphen-insensitive (hyphens can be used in place of underscores).
getFormatJavadoc() - Method in class org.plumelib.options.OptionsDoclet
Returns true if the output format is Javadoc, false if the output format is HTML.
getOptionGroups() - Method in class org.plumelib.options.Options
 
getOptions() - Method in class org.plumelib.options.Options
 
getOptionsString() - Method in class org.plumelib.options.Options
Returns a string containing all of the options that were set and their arguments.
getRefArg(Options.OptionInfo, String, String) - Method in class org.plumelib.options.Options
Given a value string supplied on the command line, create an object.
getUseSingleDash() - Method in class org.plumelib.options.Options
 
getUseSingleDash() - Method in class org.plumelib.options.OptionsDoclet
groupMap - Variable in class org.plumelib.options.Options
Map from option group name to option group information.

H

hasGroups - Variable in class org.plumelib.options.Options
If true, then the user is using @OptionGroup annotations correctly (as per the requirement specified above).
hasGroups() - Method in class org.plumelib.options.Options
 
hasListOption - Variable in class org.plumelib.options.Options
True if some documented option accepts a list as a parameter.

I

includeClassDoc - Variable in class org.plumelib.options.OptionsDoclet
If true, then include the class's main Javadoc comment.
inPlace - Variable in class org.plumelib.options.OptionsDoclet
If true, then edit docFile in place (and docFile is non-null).

J

javadocToHtml(Doc) - Static method in class org.plumelib.options.OptionsDoclet
Replace the @link tags and block @see tags in a Javadoc comment with HTML.
jdoc - Variable in class org.plumelib.options.Options.OptionInfo
Full Javadoc description.

L

length() - Method in class org.plumelib.options.StringBuilderDelimited
 
lineSeparator - Static variable in class org.plumelib.options.Options
The system-dependent line separator.
list - Variable in class org.plumelib.options.Options.OptionInfo
If the option is a list, this references that list.
LIST_HELP - Static variable in class org.plumelib.options.Options
String describing "[+]" (copied from Mercurial).
LIST_HELP - Static variable in class org.plumelib.options.OptionsDoclet
 
longName - Variable in class org.plumelib.options.Options.OptionInfo
Long argument name.

M

mainClass - Variable in class org.plumelib.options.Options
First specified class.
maxOptionLength(List<Options.OptionInfo>, boolean) - Method in class org.plumelib.options.Options
Return the length of the longest synopsis message in a list of options.

N

name - Variable in class org.plumelib.options.Options.OptionGroupInfo
The name of this option group.
nameMap - Variable in class org.plumelib.options.Options
Map from short or long option names (with leading dashes) to option information.
needsInstantiation(Class<?>) - Static method in class org.plumelib.options.OptionsDoclet
Determine if a class needs to be instantiated in order to work properly with Options.
newDocFileText() - Method in class org.plumelib.options.OptionsDoclet
Get the result of inserting the options documentation into the docfile.
noDocDefault - Variable in class org.plumelib.options.Options.OptionInfo
If true, the default value string for this option will be excluded from OptionsDoclet documentation.

O

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
 
OptionGroupInfo(OptionGroup) - Constructor for class org.plumelib.options.Options.OptionGroupInfo
 
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
 
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
 
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
 
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
 
outFile - Variable in class org.plumelib.options.OptionsDoclet
 
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
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.
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.
parseAfterArg - Variable in class org.plumelib.options.Options
Whether to parse options after a non-option command-line argument.
parseOption(String) - Static method in class org.plumelib.options.Options
Parse an option value (the argument to @Option) and return its three components (shortName, typeName, and description).
ParseResult(String, String, String) - Constructor for class org.plumelib.options.Options.ParseResult
 
printClassPath() - Static method in class org.plumelib.options.Options
Print the classpath.
printUsage(PrintStream) - Method in class org.plumelib.options.Options
Prints usage information to the given PrintStream.
printUsage() - Method in class org.plumelib.options.Options
Prints, to standard output, usage information.
processEnumJavadoc(Options.OptionInfo) - Method in class org.plumelib.options.OptionsDoclet
Initializes Options.OptionInfo.enumJdoc for the given OptionInfo: creates a mapping from enum constants to their Javadoc
processJavadoc() - Method in class org.plumelib.options.OptionsDoclet
Adds Javadoc info to each option in options.getOptions().

R

refill(String, int, int, int) - Method in class org.plumelib.options.OptionsDoclet
Refill the string so that each line is refillWidth characters long.
root - Variable in class org.plumelib.options.OptionsDoclet
 

S

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
 
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
 
StringBuilderDelimited - Class in org.plumelib.options
 
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
synopsis() - Method in class org.plumelib.options.Options.OptionInfo
Returns a short synopsis of the option in the form -s --long=<type>.

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.OptionInfo
Return a one-line description of the option.
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
 
typeName - Variable in class org.plumelib.options.Options.OptionInfo
Name of the argument type.
typeName - Variable in class org.plumelib.options.Options.ParseResult
 
typeShortName(Class<?>) - Static method in class org.plumelib.options.Options
Return a short name for the specified type for use in messages.

U

unpublicized - Variable in class org.plumelib.options.Options.OptionGroupInfo
If true, this group of options will not be printed in usage output by default.
unpublicized - Variable in class org.plumelib.options.Options.OptionInfo
If true, this OptionInfo is not output when printing documentation.
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(String...) - Method in class org.plumelib.options.Options
Returns a usage message for command-line options.
usage(boolean, String...) - Method in class org.plumelib.options.Options
Returns a usage message for command-line options.
USAGE - Static variable in class org.plumelib.options.OptionsDoclet
 
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

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 B C D E F G H I J L M N O P R S T U V W 
Skip navigation links