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

A

action() - Method in class gnu.dtools.ritopt.Option
Prepares the option for modification.
action(char, char) - Method in class gnu.dtools.ritopt.OptionModule
Called by the OptionsProcessor when an option in the target module is invoked.
action(String, char) - Method in class gnu.dtools.ritopt.OptionModule
Called by the OptionsProcessor when an option in the target module is invoked.
action(char, String) - Method in class gnu.dtools.ritopt.OptionModule
Called by the OptionsProcessor when an option in the target module is invoked.
action(String, String) - Method in class gnu.dtools.ritopt.OptionModule
Called by the OptionsProcessor when an option in the target module is invoked.
addOptionListener(OptionListener) - Method in class gnu.dtools.ritopt.NotifyOption
Adds an OptionListener to the notification list.
addOptionListener(OptionListener) - Method in interface gnu.dtools.ritopt.OptionNotifier
Adds an OptionListener to the notification list.
ArrayOption - Class in gnu.dtools.ritopt
The principal base class used to register option variables that represent arrays or Collections.
ArrayOption() - Constructor for class gnu.dtools.ritopt.ArrayOption
Builds and initializes ArrayOption class members, and invokes the Option constructor.

B

BooleanOption - Class in gnu.dtools.ritopt
This class is used for options with boolean values.
BooleanOption() - Constructor for class gnu.dtools.ritopt.BooleanOption
Constructs a boolean option that is initially false.
BooleanOption(BooleanOption) - Constructor for class gnu.dtools.ritopt.BooleanOption
Constructs a boolean option by copying the boolean option passed.
BooleanOption(boolean) - Constructor for class gnu.dtools.ritopt.BooleanOption
Constructs a boolean option initialized with the value passed.
BooleanOption(boolean, String) - Constructor for class gnu.dtools.ritopt.BooleanOption
Constructs a boolean option initialized with the value and long option passed.
BooleanOption(boolean, char) - Constructor for class gnu.dtools.ritopt.BooleanOption
Constructs a boolean option initialized with the value and short option passed.
BooleanOption(boolean, String, char) - Constructor for class gnu.dtools.ritopt.BooleanOption
Constructs a boolean option initialized with the value, short and long option passed.
ByteOption - Class in gnu.dtools.ritopt
This class is used for options with byte values.
ByteOption() - Constructor for class gnu.dtools.ritopt.ByteOption
Constructs a byte option that is set to the null character.
ByteOption(ByteOption) - Constructor for class gnu.dtools.ritopt.ByteOption
Constructs a byte option by copying the byte option passed.
ByteOption(byte) - Constructor for class gnu.dtools.ritopt.ByteOption
Constructs a byte option initialized with the value passed.
ByteOption(byte, String) - Constructor for class gnu.dtools.ritopt.ByteOption
Constructs a byte option initialized with the value and long option passed.
ByteOption(byte, char) - Constructor for class gnu.dtools.ritopt.ByteOption
Constructs a byte option initialized with the value and short option passed.
ByteOption(byte, String, char) - Constructor for class gnu.dtools.ritopt.ByteOption
Constructs a byte option initialized with the value, short and long option passed.

C

CharOption - Class in gnu.dtools.ritopt
This class is used for options with character values.
CharOption() - Constructor for class gnu.dtools.ritopt.CharOption
Constructs a character option that is set to the space character.
CharOption(CharOption) - Constructor for class gnu.dtools.ritopt.CharOption
Constructs a character option by copying the character option passed.
CharOption(char) - Constructor for class gnu.dtools.ritopt.CharOption
Constructs a character option initialized with the value passed.
CharOption(char, String) - Constructor for class gnu.dtools.ritopt.CharOption
Constructs a character option initialized with the value and long option passed.
CharOption(char, char) - Constructor for class gnu.dtools.ritopt.CharOption
Constructs a character option initialized with the value and short option passed.
CharOption(char, String, char) - Constructor for class gnu.dtools.ritopt.CharOption
Constructs a character option initialized with the value, short and long option passed.
contains(String, String) - Static method in class gnu.dtools.ritopt.Utility
Returns true if any of the characters in the list appear in the check string passed.
contains(char, String) - Static method in class gnu.dtools.ritopt.Utility
Returns true if any of the characters in the list are equal to the check character.
count(String, char) - Static method in class gnu.dtools.ritopt.Utility
Returns the number of occurances the character specification appears in the check string passed.

D

DEFAULT_DEPRECATED - Static variable in class gnu.dtools.ritopt.OptionModule
The default deprecation status.
DEFAULT_DEPRECATED - Static variable in class gnu.dtools.ritopt.Options
This boolean defines whether options are deprecated by default.
DEFAULT_DESCRIPTION - Static variable in class gnu.dtools.ritopt.OptionModule
The default description.
DEFAULT_DISPLAY_USAGE - Static variable in class gnu.dtools.ritopt.Options
This boolean defines whether usage should be displayed.
DEFAULT_FILE_COMMENT_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the comment in an option file.
DEFAULT_FILE_COMPLETE_OPTION_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the option assignment in an option file.
DEFAULT_GENERAL_MODULE_NAME - Static variable in class gnu.dtools.ritopt.Options
The default general module name.
DEFAULT_HELP_DEPRECATED_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the deprecated field when the help usage is displayed.
DEFAULT_HELP_DESCRIPTION_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the description when the help usage is displayed.
DEFAULT_HELP_OPTION_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the option field when the help usage is displayed.
DEFAULT_HELP_TYPENAME_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the type name field when the help usage is display.
DEFAULT_LONG_OPTION - Static variable in class gnu.dtools.ritopt.OptionModule
The default long option.
DEFAULT_MENU_DEPRECATED_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the deprecated field when the menu usage is displayed.
DEFAULT_MENU_DESCRIPTION_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the description field when the menu usage is displayed.
DEFAULT_MENU_OPTION_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the option field when the menu usage is displayed.
DEFAULT_MENU_TYPENAME_SIZE - Static variable in class gnu.dtools.ritopt.Option
The default width of the type name field when the menu usage is displayed.
DEFAULT_MODULE_NAME - Static variable in class gnu.dtools.ritopt.OptionModule
The default module name.
DEFAULT_OPTION_FILENAME - Static variable in class gnu.dtools.ritopt.Options
The default option file.
DEFAULT_PROGRAM_NAME - Static variable in class gnu.dtools.ritopt.Options
The default program name that is display in the usage.
DEFAULT_REASON - Static variable in class gnu.dtools.ritopt.Options
The default reason for deprecation.
DEFAULT_SHORT_OPTION - Static variable in class gnu.dtools.ritopt.OptionModule
The default short option.
DEFAULT_USE_MENU - Static variable in class gnu.dtools.ritopt.Options
This boolean defines whether the menu should be used.
DEFAULT_VERBOSITY - Static variable in class gnu.dtools.ritopt.Options
The default verbosity.
deprecate() - Method in class gnu.dtools.ritopt.Option
Deprecates this option.
destroy() - Method in class gnu.dtools.ritopt.SimpleProcess
Destroys the target process.
displayHelp() - Method in class gnu.dtools.ritopt.Options
Displays the program's help which includes a description of each option.
displayVersion() - Method in class gnu.dtools.ritopt.Options
Displays the version of the program.
DoubleOption - Class in gnu.dtools.ritopt
This class is used for options with double values.
DoubleOption() - Constructor for class gnu.dtools.ritopt.DoubleOption
Constructs a double option that is initially set to zero.
DoubleOption(DoubleOption) - Constructor for class gnu.dtools.ritopt.DoubleOption
Constructs a double option by copying the double option passed.
DoubleOption(double) - Constructor for class gnu.dtools.ritopt.DoubleOption
Constructs a double option initialized with the value passed.
DoubleOption(double, String) - Constructor for class gnu.dtools.ritopt.DoubleOption
Constructs a double option initialized with the value and long option passed.
DoubleOption(double, char) - Constructor for class gnu.dtools.ritopt.DoubleOption
Constructs a character option initialized with the value and short option passed.
DoubleOption(double, String, char) - Constructor for class gnu.dtools.ritopt.DoubleOption
Constructs a double option initialized with the value, short and long option passed.

E

EXIT_MENU_COMMAND_CHAR - Static variable in class gnu.dtools.ritopt.OptionMenu
This command exits the built-in menu system.
exitValue() - Method in class gnu.dtools.ritopt.SimpleProcess
Returns the target processes' exit value.
expandString(String, int) - Static method in class gnu.dtools.ritopt.Utility
Returns a string with no more and no less than n characters where n is the length.

F

FILE_MODULE_COMMAND_CHAR - Static variable in class gnu.dtools.ritopt.OptionMenu
Loads an option module.
FILE_READ_COMMAND_CHAR - Static variable in class gnu.dtools.ritopt.OptionMenu
This command without any arguments loads the default option file.
FILE_WRITE_COMMAND_CHAR - Static variable in class gnu.dtools.ritopt.OptionMenu
This command without any arguments writes to the default option file.
FloatOption - Class in gnu.dtools.ritopt
This class is used for options with float values.
FloatOption() - Constructor for class gnu.dtools.ritopt.FloatOption
Constructs a float option that is initially set to zero.
FloatOption(FloatOption) - Constructor for class gnu.dtools.ritopt.FloatOption
Constructs a float option by copying the float option passed.
FloatOption(float) - Constructor for class gnu.dtools.ritopt.FloatOption
Constructs a float option initialized with the value passed.
FloatOption(float, String) - Constructor for class gnu.dtools.ritopt.FloatOption
Constructs a float option initialized with the value and long option passed.
FloatOption(float, char) - Constructor for class gnu.dtools.ritopt.FloatOption
Constructs a character option initialized with the value and short option passed.
FloatOption(float, String, char) - Constructor for class gnu.dtools.ritopt.FloatOption
Constructs a float option initialized with the value, short and long option passed.

G

getCommand() - Method in class gnu.dtools.ritopt.OptionEvent
Returns the command string associated with the option.
getDebugFlag() - Method in class gnu.dtools.ritopt.Options
Returns whether debugging information should be displayed.
getDefaultOptionFilename() - Method in class gnu.dtools.ritopt.Options
Returns the option filename to load or write to if one is not specified.
getDescription() - Method in class gnu.dtools.ritopt.Option
The description explaining the meaning of this option.
getErrorStream() - Method in class gnu.dtools.ritopt.SimpleProcess
Returns the standard error of this process.
getFileCommentSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for assignment portion of a option file line.
getFileCompleteOptionSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for assignment portion of a option file line.
getHashKey() - Method in class gnu.dtools.ritopt.Option
The hash key of this option.
getHashKey(String) - Static method in class gnu.dtools.ritopt.Option
The hash key of an option if there is no short option.
getHashKey(char) - Static method in class gnu.dtools.ritopt.Option
The hash key of an option if there is no long option.
getHashKey(String, char) - Static method in class gnu.dtools.ritopt.Option
The hash key of an option if there both short and long options are defined.
getHelp() - Method in class gnu.dtools.ritopt.Option
Return a line used for help reporting.
getHelp() - Method in class gnu.dtools.ritopt.OptionModule
Returns the help information as a String.
getHelp() - Method in class gnu.dtools.ritopt.Options
Returns the help information as a string.
getHelpDeprecated() - Method in class gnu.dtools.ritopt.Option
Return the deprecated field used during help reporting.
getHelpDeprecatedSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for the deprecated flag displayed in the help report.
getHelpDescription() - Method in class gnu.dtools.ritopt.Option
Return the description field used during help reporting.
getHelpDescriptionSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for the description displayed in the help report.
getHelpHeader() - Static method in class gnu.dtools.ritopt.Option
Return the header displayed at the top of the help report.
getHelpOptionSpecification() - Method in class gnu.dtools.ritopt.Option
Return the option specification field used during help reporting.
getHelpOptionSpecificationSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for the option specification displayed in the help report.
getHelpTypeName() - Method in class gnu.dtools.ritopt.Option
Return the type name field used during help reporting.
getHelpTypenameSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for the type name displayed in the help report.
getInputStream() - Method in class gnu.dtools.ritopt.SimpleProcess
Returns the standard output of this process.
getLongOption() - Method in class gnu.dtools.ritopt.Option
Return the long option key.
getMenuDeprecatedSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for the deprecated flag displayed in the menu listing of options.
getMenuDescriptionSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for the description displayed in the menu listing of options.
getMenuOptionSpecificationSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for the option specification displayed in the menu listing of options.
getMenuTypenameSize() - Static method in class gnu.dtools.ritopt.Option
Returns the field width for the type name displayed in the menu listing of options.
getModule(String) - Method in class gnu.dtools.ritopt.Options
Retrieves an option module based on the name passed.
getName() - Method in class gnu.dtools.ritopt.Option
Return the name of this option.
getName() - Method in class gnu.dtools.ritopt.OptionModule
Returns the name of this module.
getObject() - Method in class gnu.dtools.ritopt.BooleanOption
Return the value as an object.
getObject() - Method in class gnu.dtools.ritopt.ByteOption
Return the value as an object.
getObject() - Method in class gnu.dtools.ritopt.CharOption
Return the value as an object.
getObject() - Method in class gnu.dtools.ritopt.DoubleOption
Return the value as an object.
getObject() - Method in class gnu.dtools.ritopt.FloatOption
Return the value as an object.
getObject() - Method in class gnu.dtools.ritopt.IntOption
Return the value as an object.
getObject() - Method in class gnu.dtools.ritopt.LongOption
Return the value as an object.
getObject() - Method in class gnu.dtools.ritopt.NotifyOption
Return the value as an object.
getObject() - Method in class gnu.dtools.ritopt.Option
Returns this option's value as an Object.
getObject() - Method in class gnu.dtools.ritopt.ShortOption
Return the value as an object.
getObject() - Method in class gnu.dtools.ritopt.StringOption
Return the value as an object.
getObjectArray() - Method in class gnu.dtools.ritopt.ArrayOption
Get an ArrayOption in array form.
getObjectList() - Method in class gnu.dtools.ritopt.ArrayOption
Get a list of objects representing the elements of this array option.
getOption(char) - Method in class gnu.dtools.ritopt.OptionModule
Returns the option referred by the long option passed.
getOption(String) - Method in class gnu.dtools.ritopt.OptionModule
Returns the option referred by the long option passed.
getOptionFileLine() - Method in class gnu.dtools.ritopt.Option
Returns (a) line(s) representing this option.
getOptionIterator() - Method in class gnu.dtools.ritopt.OptionModule
Return an iterator over the option repository contained in this module.
getOutputStream() - Method in class gnu.dtools.ritopt.SimpleProcess
Returns the standard input of this process.
getShortOption() - Method in class gnu.dtools.ritopt.Option
Return the short option key.
getSpaces(int) - Static method in class gnu.dtools.ritopt.Utility
Returns a string containing the number of spaces passed as an argument.
getStringValue() - Method in class gnu.dtools.ritopt.BooleanOption
Return this option as a string.
getStringValue() - Method in class gnu.dtools.ritopt.ByteOption
Return this option as a string.
getStringValue() - Method in class gnu.dtools.ritopt.CharOption
Return this option as a string.
getStringValue() - Method in class gnu.dtools.ritopt.DoubleOption
Return this option as a string.
getStringValue() - Method in class gnu.dtools.ritopt.FloatOption
Return this option as a string.
getStringValue() - Method in class gnu.dtools.ritopt.IntOption
Return this option as a string.
getStringValue() - Method in class gnu.dtools.ritopt.LongOption
Return this option as a string.
getStringValue() - Method in class gnu.dtools.ritopt.NotifyOption
Return this option as a string.
getStringValue() - Method in class gnu.dtools.ritopt.Option
Returns the option's value as a String.
getStringValue() - Method in class gnu.dtools.ritopt.ShortOption
Return this option as a string.
getStringValue() - Method in class gnu.dtools.ritopt.StringOption
Return this option as a string.
getTarget() - Method in class gnu.dtools.ritopt.OptionEvent
Returns the target option of the option processing event.
getTarget() - Method in exception gnu.dtools.ritopt.OptionRegistrationException
Returns the target option associated with the registration failure.
getTypeName() - Method in class gnu.dtools.ritopt.BooleanOption
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.ByteOption
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.CharOption
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.DoubleOption
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.FloatOption
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.IntOption
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.LongOption
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.NotifyOption
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.Option
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.ShortOption
Returns the type name of this option.
getTypeName() - Method in class gnu.dtools.ritopt.StringOption
Returns the type name of this option.
getUsage() - Method in class gnu.dtools.ritopt.Options
Returns usage information of this program.
getUsageProgram() - Method in class gnu.dtools.ritopt.Options
Returns the program name displayed in the usage.
getValue() - Method in class gnu.dtools.ritopt.BooleanOption
Return this option as a boolean.
getValue() - Method in class gnu.dtools.ritopt.ByteOption
Return this option as a boolean.
getValue() - Method in class gnu.dtools.ritopt.CharOption
Return this option as a character.
getValue() - Method in class gnu.dtools.ritopt.DoubleOption
Return this option as a double.
getValue() - Method in class gnu.dtools.ritopt.FloatOption
Return this option as a float.
getValue() - Method in class gnu.dtools.ritopt.IntOption
Return this option as an integer.
getValue() - Method in class gnu.dtools.ritopt.LongOption
Return this option as a long.
getValue() - Method in class gnu.dtools.ritopt.NotifyOption
Return this option as a string.
getValue() - Method in class gnu.dtools.ritopt.OptionEvent
Returns the value associated with the target option.
getValue() - Method in class gnu.dtools.ritopt.ShortOption
Return this option as a short.
getValue() - Method in class gnu.dtools.ritopt.StringOption
Modify this option using a string value.
getVersion() - Method in class gnu.dtools.ritopt.Options
Returns the version of the program.
gnu.dtools.ritopt - package gnu.dtools.ritopt
 

H

HELP_COMMAND_CHAR - Static variable in class gnu.dtools.ritopt.OptionMenu
This command without any arguments displays the command summary.

I

IntOption - Class in gnu.dtools.ritopt
This class is used for options with integer values.
IntOption() - Constructor for class gnu.dtools.ritopt.IntOption
Constructs an integer option that is initially set to zero.
IntOption(IntOption) - Constructor for class gnu.dtools.ritopt.IntOption
Constructs an integer option by copying the integer option passed.
IntOption(int) - Constructor for class gnu.dtools.ritopt.IntOption
Constructs an integer option initialized with the value passed.
IntOption(int, String) - Constructor for class gnu.dtools.ritopt.IntOption
Constructs an integer option initialized with the value and long option passed.
IntOption(int, char) - Constructor for class gnu.dtools.ritopt.IntOption
Constructs a character option initialized with the value and short option passed.
IntOption(int, String, char) - Constructor for class gnu.dtools.ritopt.IntOption
Constructs an integer option initialized with the value, short and long option passed.
invoked - Variable in class gnu.dtools.ritopt.Option
A field indicating whether an option has been invoked.
isAlpha(String) - Static method in class gnu.dtools.ritopt.Utility
Returns true if the string only contains letters in the phonetic alphabet.
isAlpha(char) - Static method in class gnu.dtools.ritopt.Utility
Returns true if the character is a letter in the phonetic alphabetic.
isAlphaLower(String) - Static method in class gnu.dtools.ritopt.Utility
Returns true if the string only contains lower case letters in the phonetic alphabet.
isAlphaLower(char) - Static method in class gnu.dtools.ritopt.Utility
Returns true if the character is a lower case letter in the phonetic alphabetic.
isAlphaNumeric(char) - Static method in class gnu.dtools.ritopt.Utility
Returns true if the character is a letter in the phonetic alphabetic or is a decimal number.
isAlphaUpper(String) - Static method in class gnu.dtools.ritopt.Utility
Returns true if the string only contains upper case letters in the phonetic alphabet.
isAlphaUpper(char) - Static method in class gnu.dtools.ritopt.Utility
Returns true if the character is a upper case letter in the phonetic alphabetic.
isDeprecated() - Method in class gnu.dtools.ritopt.Option
Returns whether this option is deprecated.
isDeprecated() - Method in class gnu.dtools.ritopt.OptionModule
Returns whether this module is deprecated.
isInvoked() - Method in class gnu.dtools.ritopt.Option
Returns whether this option has been invoked.
isNumeric(char) - Static method in class gnu.dtools.ritopt.Utility
Returns true if the character is a decimal number.
isStopped() - Method in interface gnu.dtools.ritopt.Stoppable
Returns whether the implementor has stopped.
isStopped() - Method in class gnu.dtools.ritopt.StreamPrinter
Returns whether this StreamPrinter has stopped processing.

J

join() - Method in class gnu.dtools.ritopt.StreamPrinter
Joins this StreamPrinter's thread with the other threads.

L

LIST_MODULES_COMMAND_CHAR - Static variable in class gnu.dtools.ritopt.OptionMenu
This command lists registered option modules.
loadOptionFile(String) - Method in class gnu.dtools.ritopt.Options
Loads all options and their modules from an options file.
LongOption - Class in gnu.dtools.ritopt
This class is used for options with long values.
LongOption() - Constructor for class gnu.dtools.ritopt.LongOption
Constructs a long option that is initially set to zero.
LongOption(LongOption) - Constructor for class gnu.dtools.ritopt.LongOption
Constructs a long option by copying the long option passed.
LongOption(long) - Constructor for class gnu.dtools.ritopt.LongOption
Constructs a long option initialized with the value passed.
LongOption(long, String) - Constructor for class gnu.dtools.ritopt.LongOption
Constructs a long option initialized with the value and long option passed.
LongOption(long, char) - Constructor for class gnu.dtools.ritopt.LongOption
Constructs a character option initialized with the value and short option passed.
LongOption(long, String, char) - Constructor for class gnu.dtools.ritopt.LongOption
Constructs a long option initialized with the value, short and long option passed.
ltrim(String) - Static method in class gnu.dtools.ritopt.Utility
Trim spaces off the left side of this string.

M

MENU_PROMPT - Static variable in class gnu.dtools.ritopt.OptionMenu
The menu prompt used for the built-in menu system.
modify(String) - Method in class gnu.dtools.ritopt.BooleanOption
Modify this option based on a string representation.
modify(String) - Method in class gnu.dtools.ritopt.ByteOption
Modify this option based on a string representation.
modify(String) - Method in class gnu.dtools.ritopt.CharOption
Modify this option based on a string representation.
modify(String) - Method in class gnu.dtools.ritopt.DoubleOption
Modify this option based on a string representation.
modify(String) - Method in class gnu.dtools.ritopt.FloatOption
Modify this option based on a string representation.
modify(String) - Method in class gnu.dtools.ritopt.IntOption
Modify this option based on a string representation.
modify(String) - Method in class gnu.dtools.ritopt.LongOption
Modify this option based on a string representation.
modify(String) - Method in class gnu.dtools.ritopt.NotifyOption
Modify this option based on a string representation.
modify(String[]) - Method in interface gnu.dtools.ritopt.OptionArrayable
Modify an option based on several string representations.
modify(String) - Method in interface gnu.dtools.ritopt.OptionModifiable
Modify an option based on a string representation.
modify(String) - Method in class gnu.dtools.ritopt.ShortOption
Modify this option based on a string representation.
modify(String) - Method in class gnu.dtools.ritopt.StringOption
Modify this option based on a string representation.
moduleExists(String) - Method in class gnu.dtools.ritopt.Options
Returns a boolean indicating whether an option module exists.

N

NotifyOption - Class in gnu.dtools.ritopt
The NotifyOption class is used to register options that when invoked notify a listener.
NotifyOption() - Constructor for class gnu.dtools.ritopt.NotifyOption
Construct a NotifyOption with an empty list of listeners.
NotifyOption(OptionListener) - Constructor for class gnu.dtools.ritopt.NotifyOption
Construct a NotifyOption and register the passed listener.
NotifyOption(OptionListener, String) - Constructor for class gnu.dtools.ritopt.NotifyOption
Construct a NotifyOption and register the passed listener.
NotifyOption(OptionListener, String, String) - Constructor for class gnu.dtools.ritopt.NotifyOption
Construct a NotifyOption and register the passed listener.
NotifyOption(NotifyOption) - Constructor for class gnu.dtools.ritopt.NotifyOption
Construct a NotifyOption by copying the NotifyOption passed.
NotifyOption(String) - Constructor for class gnu.dtools.ritopt.NotifyOption
Construct a NotifyOption, and initialize its default value to the value passed.
NotifyOption(String, String) - Constructor for class gnu.dtools.ritopt.NotifyOption
Constructs a NotifyOption option initialized with the value and long option passed.
NotifyOption(String, char) - Constructor for class gnu.dtools.ritopt.NotifyOption
Constructs a character option initialized with the value and short option passed.
NotifyOption(String, String, char) - Constructor for class gnu.dtools.ritopt.NotifyOption
Constructs an NotifyOption option initialized with the value, short and long option passed.

O

Option - Class in gnu.dtools.ritopt
This is the principal base class for all Option classes.
Option() - Constructor for class gnu.dtools.ritopt.Option
Constructs an option with no initial short or long option value, and is by default uninvoked and undeprecated, and has a description initialized to the empty string.
Option(Option) - Constructor for class gnu.dtools.ritopt.Option
Constructs an option by copying the option passed.
Option(String) - Constructor for class gnu.dtools.ritopt.Option
Constructs an option by initializing its long option with the value passed.
Option(char) - Constructor for class gnu.dtools.ritopt.Option
Constructs an option by initializing its short option with the value passed.
Option(String, char) - Constructor for class gnu.dtools.ritopt.Option
Constructs an option by initializing its short and long options with the values passed.
OPTION_COMMAND_CHAR - Static variable in class gnu.dtools.ritopt.OptionMenu
Commands starting with this substring are option invocations.
OptionArrayable - Interface in gnu.dtools.ritopt
If an option supports array registration and processing then it should implement this interface.
OptionEvent - Class in gnu.dtools.ritopt
An event indicating that an option has been invoked.
OptionEvent() - Constructor for class gnu.dtools.ritopt.OptionEvent
Constructs an option event with the command set to "Default", the value set to the empty string, and the target set to null.
OptionEvent(String) - Constructor for class gnu.dtools.ritopt.OptionEvent
Constructs an option event with the command set to the value passed, the value set to the empty string, and the target set to null.
OptionEvent(String, String) - Constructor for class gnu.dtools.ritopt.OptionEvent
Constructs an option event with the command and value set to the values passed, and the target set to null.
OptionEvent(Option) - Constructor for class gnu.dtools.ritopt.OptionEvent
Constructs an option event with the command set to the long or short option (whichever exists), the value set to the current value of the option, and the target option set to the option passed.
OptionEvent(String, String, Option) - Constructor for class gnu.dtools.ritopt.OptionEvent
Constructs an option event with the command, value, and target set to the values passed.
OptionException - Exception in gnu.dtools.ritopt
An OptionException is thrown when an error occurs during option processing, modification, or registration.
optionExists(Option) - Method in class gnu.dtools.ritopt.OptionModule
Returns whether the option exists in this module.
optionExists(char) - Method in class gnu.dtools.ritopt.OptionModule
Returns whether the option referred by a short option exists in this module.
optionExists(String) - Method in class gnu.dtools.ritopt.OptionModule
Returns whether the option referred by a long option exists in this module.
optionInvoked(OptionEvent) - Method in interface gnu.dtools.ritopt.OptionListener
Invoked when an option processing event occurs.
optionInvoked(OptionEvent) - Method in class gnu.dtools.ritopt.OptionMenu
This method is notified when the --menu option is specified.
optionInvoked(OptionEvent) - Method in class gnu.dtools.ritopt.Options
Receives NotifyOption events.
OptionListener - Interface in gnu.dtools.ritopt
This interface is used to receive notification of option processing events.
OptionMenu - Class in gnu.dtools.ritopt
This class facilitates the built-in menu feature for ritopt.
OptionMenu(Options) - Constructor for class gnu.dtools.ritopt.OptionMenu
Constructs a new built-in menu attaching it to the options registrar passed.
OptionModifiable - Interface in gnu.dtools.ritopt
Implementors of this interface are capable of being registered and processed.
OptionModificationException - Exception in gnu.dtools.ritopt
Instances of this class are thrown if there is an error during modification of an option's value.
OptionModule - Class in gnu.dtools.ritopt
This class is used as a repository for options.
OptionModule() - Constructor for class gnu.dtools.ritopt.OptionModule
Constructs an OptionModule with the default name.
OptionModule(String) - Constructor for class gnu.dtools.ritopt.OptionModule
Constructs an OptionModule with the name passed.
OptionModuleRegistrar - Interface in gnu.dtools.ritopt
Implementors are capable of registering option modules and storing them in a repository.
OptionNotifier - Interface in gnu.dtools.ritopt
If an object is able notify and maintain a repository of listeners, it should implement this interface even though it is not required.
OptionProcessingException - Exception in gnu.dtools.ritopt
Instances of this exception are thrown when an error occurs when processing the command line.
OptionRegistrar - Interface in gnu.dtools.ritopt
Implementors are capable of registering options and storing them in a repository.
OptionRegistrationException - Exception in gnu.dtools.ritopt
This exception indicates that an error has occurred during registration of an option, registrar, or module.
OptionRegistrationException(String) - Constructor for exception gnu.dtools.ritopt.OptionRegistrationException
Construct an OptionRegistrationException.
OptionRegistrationException(String, Option) - Constructor for exception gnu.dtools.ritopt.OptionRegistrationException
Construct an OptionRegisrationException and initialize its members with the message and target passed.
Options - Class in gnu.dtools.ritopt
This class functions as a repository for options and their modules.
Options() - Constructor for class gnu.dtools.ritopt.Options
Create an option repository.
Options(String) - Constructor for class gnu.dtools.ritopt.Options
Create an option repository and associated it with a program name.

P

process(String[]) - Method in class gnu.dtools.ritopt.Options
Process a string of values representing the invoked options.
process(String) - Method in class gnu.dtools.ritopt.Options
Process a string representing the invoked options.

R

register(String, Option) - Method in class gnu.dtools.ritopt.OptionModule
Register an option into the repository as a long option.
register(char, Option) - Method in class gnu.dtools.ritopt.OptionModule
Register an option into the repository as a short option.
register(String, char, Option) - Method in class gnu.dtools.ritopt.OptionModule
Register an option into the repository both as a short and long option.
register(String, char, String, Option) - Method in class gnu.dtools.ritopt.OptionModule
Register an option into the repository both as a short and long option.
register(String, char, String, Option, boolean) - Method in class gnu.dtools.ritopt.OptionModule
Register an option into the repository both as a short and long option.
register(OptionModule) - Method in interface gnu.dtools.ritopt.OptionModuleRegistrar
Register an option module based on its name.
register(String, OptionModule) - Method in interface gnu.dtools.ritopt.OptionModuleRegistrar
Register an option module and associate it with the name passed.
register(String, Option) - Method in interface gnu.dtools.ritopt.OptionRegistrar
Register an option into the repository as a long option.
register(char, Option) - Method in interface gnu.dtools.ritopt.OptionRegistrar
Register an option into the repository as a short option.
register(String, char, Option) - Method in interface gnu.dtools.ritopt.OptionRegistrar
Register an option into the repository both as a short and long option.
register(String, char, String, Option) - Method in interface gnu.dtools.ritopt.OptionRegistrar
Register an option into the repository both as a short and long option.
register(String, char, String, Option, boolean) - Method in interface gnu.dtools.ritopt.OptionRegistrar
Register an option into the repository both as a short and long option.
register(String, Option) - Method in class gnu.dtools.ritopt.Options
Register an option into the repository as a long option.
register(char, Option) - Method in class gnu.dtools.ritopt.Options
Register an option into the repository as a short option.
register(String, char, Option) - Method in class gnu.dtools.ritopt.Options
Register an option into the repository both as a short and long option.
register(String, char, String, Option) - Method in class gnu.dtools.ritopt.Options
Register an option into the repository both as a short and long option.
register(String, char, String, Option, boolean) - Method in class gnu.dtools.ritopt.Options
Register an option into the repository both as a short and long option.
register(OptionModule) - Method in class gnu.dtools.ritopt.Options
Register an option module based on its name.
register(String, OptionModule) - Method in class gnu.dtools.ritopt.Options
Register an option module and associate it with the name passed.
removeOptionListener(OptionListener) - Method in class gnu.dtools.ritopt.NotifyOption
Removes an OptionListener from the notification list.
removeOptionListener(OptionListener) - Method in interface gnu.dtools.ritopt.OptionNotifier
Removes an OptionListener from the notification list.
repeat(char, int) - Static method in class gnu.dtools.ritopt.Utility
Returns a string with a character repeated based on a count passed.
repeat(String, int) - Static method in class gnu.dtools.ritopt.Utility
Returns a string with the passed string repeated based on the integer count passed.
rtrim(String) - Static method in class gnu.dtools.ritopt.Utility
Trim spaces off the right side of this string.
run() - Method in class gnu.dtools.ritopt.StreamPrinter
Start the StreamPrinter thread.
RUN_COMMAND_CHAR - Static variable in class gnu.dtools.ritopt.OptionMenu
This command must have an argument.

S

setCommand(String) - Method in class gnu.dtools.ritopt.OptionEvent
Sets the command string to the value passed.
setDebugFlag(boolean) - Method in class gnu.dtools.ritopt.Options
Sets the debugging flag.
setDefaultOptionFilename(String) - Method in class gnu.dtools.ritopt.Options
Sets the option file to use when an option file is not specified.
setDeprecated(boolean) - Method in class gnu.dtools.ritopt.Option
Sets the deprecated flag to the value passed.
setDeprecated(boolean) - Method in class gnu.dtools.ritopt.OptionModule
Sets whether this module is deprecated.
setDescription(String) - Method in class gnu.dtools.ritopt.Option
Sets the description of this option.
setDisplayUsage(boolean) - Method in class gnu.dtools.ritopt.Options
Sets whether usage can be displayed.
setFileCommentSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the assignment field width used when options files are written.
setFileCompleteOptionSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the assignment field width used when options files are written.
setFlush(boolean) - Method in class gnu.dtools.ritopt.StreamPrinter
Sets whether the output stream should be flushed after each output step.
setHelpDeprecatedSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the field width for the deprecated flag displayed in the help report.
setHelpDescriptionSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the field width for the description displayed in the help report.
setHelpOptionSpecificationSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the field width for the option specification displayed in the help report.
setHelpTypenameSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the field width for the type name displayed in the help report.
setInvoked(boolean) - Method in class gnu.dtools.ritopt.Option
Sets whether this option has been invoked.
setKey(String) - Method in class gnu.dtools.ritopt.Option
Sets the long option.
setKey(char) - Method in class gnu.dtools.ritopt.Option
Sets the short option.
setLongOption(String) - Method in class gnu.dtools.ritopt.Option
Sets the long option.
setMenuDeprecatedSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the field width for the deprecated flag displayed in the menu listing of options.
setMenuDescriptionSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the field width for the option description displayed in the menu listing of options.
setMenuOptionSpecificationSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the field width for the option specification displayed in the menu listing of options.
setMenuTypenameSize(int) - Static method in class gnu.dtools.ritopt.Option
Sets the field width for the type name displayed in the menu listing of options.
setName(String) - Method in class gnu.dtools.ritopt.OptionModule
Set the name of this module.
setOptionCommand(String) - Method in class gnu.dtools.ritopt.NotifyOption
Sets the command sent when an option is invoked.
setOptionCommand(String) - Method in interface gnu.dtools.ritopt.OptionNotifier
Sets the command sent when an option is invoked.
setShortOption(char) - Method in class gnu.dtools.ritopt.Option
Sets the short option.
setStop(Stoppable) - Method in class gnu.dtools.ritopt.StreamPrinter
Sets the object to stop when this object is finished.
setTarget(Option) - Method in class gnu.dtools.ritopt.OptionEvent
Sets the target option of the option processing event.
setUsageProgram(String) - Method in class gnu.dtools.ritopt.Options
Sets the program to display when the usage is displayed.
setUseMenu(boolean) - Method in class gnu.dtools.ritopt.Options
Sets whether the built-in menu system can be used.
setValue(String) - Method in class gnu.dtools.ritopt.BooleanOption
Modify this option based on a string representation.
setValue(boolean) - Method in class gnu.dtools.ritopt.BooleanOption
Modify this option using a boolean value.
setValue(String) - Method in class gnu.dtools.ritopt.ByteOption
Modify this option based on a string representation.
setValue(byte) - Method in class gnu.dtools.ritopt.ByteOption
Modify this option using a byte value.
setValue(String) - Method in class gnu.dtools.ritopt.CharOption
Modify this option based on a string representation.
setValue(char) - Method in class gnu.dtools.ritopt.CharOption
Modify this option using a character value.
setValue(String) - Method in class gnu.dtools.ritopt.DoubleOption
Modify this option based on a string representation.
setValue(double) - Method in class gnu.dtools.ritopt.DoubleOption
Modify this option using a double value.
setValue(String) - Method in class gnu.dtools.ritopt.FloatOption
Modify this option based on a string representation.
setValue(float) - Method in class gnu.dtools.ritopt.FloatOption
Modify this option using a float value.
setValue(String) - Method in class gnu.dtools.ritopt.IntOption
Modify this option based on a string representation.
setValue(int) - Method in class gnu.dtools.ritopt.IntOption
Modify this option using an integer value.
setValue(String) - Method in class gnu.dtools.ritopt.LongOption
Modify this option based on a string representation.
setValue(long) - Method in class gnu.dtools.ritopt.LongOption
Modify this option using a long value.
setValue(String) - Method in class gnu.dtools.ritopt.NotifyOption
Modify this option based on a string representation.
setValue(String) - Method in class gnu.dtools.ritopt.OptionEvent
Sets the value of this option event.
setValue(String) - Method in class gnu.dtools.ritopt.ShortOption
Modify this option based on a string representation.
setValue(short) - Method in class gnu.dtools.ritopt.ShortOption
Modify this option using a short value.
setValue(String) - Method in class gnu.dtools.ritopt.StringOption
Modify this option based on a string representation.
setVersion(String) - Method in class gnu.dtools.ritopt.Options
Sets the version of the program.
SHELL_COMMAND_CHAR - Static variable in class gnu.dtools.ritopt.OptionMenu
This command spawns a shell.
ShortOption - Class in gnu.dtools.ritopt
This class is used for options with short values.
ShortOption() - Constructor for class gnu.dtools.ritopt.ShortOption
Constructs a short option that is initially set to zero.
ShortOption(ShortOption) - Constructor for class gnu.dtools.ritopt.ShortOption
Constructs a short option by copying the short option passed.
ShortOption(short) - Constructor for class gnu.dtools.ritopt.ShortOption
Constructs a short option initialized with the value passed.
ShortOption(short, String) - Constructor for class gnu.dtools.ritopt.ShortOption
Constructs a short option initialized with the value and long option passed.
ShortOption(short, char) - Constructor for class gnu.dtools.ritopt.ShortOption
Constructs a character option initialized with the value and short option passed.
ShortOption(short, String, char) - Constructor for class gnu.dtools.ritopt.ShortOption
Constructs a short option initialized with the value, short and long option passed.
shouldDisplayUsage() - Method in class gnu.dtools.ritopt.Options
Returns whether the help information should display usage.
shouldUseMenu() - Method in class gnu.dtools.ritopt.Options
Returns whether the built-in menu system can be invoked.
SimpleProcess - Class in gnu.dtools.ritopt
A SimpleProcess is used to execute a shell process, and redirect an input stream to the processes' standard input, as well as redirect the processes' standard output/error to an output stream.
SimpleProcess(Process) - Constructor for class gnu.dtools.ritopt.SimpleProcess
Constructs a SimpleProcess, redirecting System.in to the its standard input, System.out to its standard output, and System.err to its standard error.
SimpleProcess(Process, InputStream, PrintStream, PrintStream) - Constructor for class gnu.dtools.ritopt.SimpleProcess
Constructs a SimpleProcess, initializing it with the streams passed.
split(String) - Method in class gnu.dtools.ritopt.Options
Splits a string representing command line arguments into several strings.
start() - Method in class gnu.dtools.ritopt.StreamPrinter
Starts the thread associated with this StreamPrinter.
startMenu() - Method in class gnu.dtools.ritopt.OptionMenu
Starts the built-in menu system.
stop() - Method in interface gnu.dtools.ritopt.Stoppable
Stop the implemetor from performing some sort of processing.
stop() - Method in class gnu.dtools.ritopt.StreamPrinter
Stops this StreamPrinter's processing.
Stoppable - Interface in gnu.dtools.ritopt
Implementors are capable of being stopped.
StreamPrinter - Class in gnu.dtools.ritopt
Reads data from an input stream and outputs to a print stream.
StreamPrinter(InputStream, PrintStream) - Constructor for class gnu.dtools.ritopt.StreamPrinter
Constructs a new StreamPrinter.
StringOption - Class in gnu.dtools.ritopt
This class is used for options with String values.
StringOption() - Constructor for class gnu.dtools.ritopt.StringOption
Constructs a string option that is initially set to zero.
StringOption(StringOption) - Constructor for class gnu.dtools.ritopt.StringOption
Constructs a string option by copying the string option passed.
StringOption(String) - Constructor for class gnu.dtools.ritopt.StringOption
Constructs a string option initialized with the value passed.
StringOption(String, String) - Constructor for class gnu.dtools.ritopt.StringOption
Constructs a string option initialized with the value and long option passed.
StringOption(String, char) - Constructor for class gnu.dtools.ritopt.StringOption
Constructs a character option initialized with the value and short option passed.
StringOption(String, String, char) - Constructor for class gnu.dtools.ritopt.StringOption
Constructs a string option initialized with the value, short and long option passed.
stripComments(String, char, char) - Static method in class gnu.dtools.ritopt.Utility
Takes a line (presumably from a file) and removes a comment if one exists.

T

toString() - Method in class gnu.dtools.ritopt.BooleanOption
Returns a string representation of this object.
toString() - Method in class gnu.dtools.ritopt.ByteOption
Returns a string representation of this object.
toString() - Method in class gnu.dtools.ritopt.CharOption
Returns a string representation of this object.
toString() - Method in class gnu.dtools.ritopt.DoubleOption
Returns a string representation of this object.
toString() - Method in class gnu.dtools.ritopt.FloatOption
Returns a string representation of this object.
toString() - Method in class gnu.dtools.ritopt.IntOption
Returns a string representation of this object.
toString() - Method in class gnu.dtools.ritopt.LongOption
Returns a string representation of this object.
toString() - Method in class gnu.dtools.ritopt.NotifyOption
Returns a string representation of this object.
toString() - Method in class gnu.dtools.ritopt.ShortOption
Returns a string representation of this object.
toString() - Method in class gnu.dtools.ritopt.StringOption
Returns a string representation of this object.
trim(String) - Static method in class gnu.dtools.ritopt.Utility
Trim spaces off both sides of this string.

U

Utility - Class in gnu.dtools.ritopt
This class provides static utility members for some basic string operations.
Utility() - Constructor for class gnu.dtools.ritopt.Utility
 

W

waitFor() - Method in class gnu.dtools.ritopt.SimpleProcess
Begin redirecting the streams passed.
writeFileToPrintStream(PrintStream) - Method in class gnu.dtools.ritopt.OptionModule
Writes the help information to a print stream.
writeOptionFile(String) - Method in class gnu.dtools.ritopt.Options
Writes all options and their modules out to an options file.
A B C D E F G H I J L M N O P R S T U W 
Skip navigation links