Alphabetical Index

A C D E F G H I L M N O P R S T U V W

A

Adds an Option to the CommandLine
addOption(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Add an option.
addProperty(String,String) - method in class net.dpml.cli.WriteableCommandLine
Adds a property value to a name in the CommandLine.
addProperty(String,String) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Add a property to the commandline.
Adds a switch value to an Option in the CommandLine.
addSwitch(net.dpml.cli.Option,boolean) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Add a switch.
Adds a value to an Option in the CommandLine.
addValue(net.dpml.cli.Option,Object) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Add an option.
ALL - static field in class net.dpml.cli.DisplaySetting
A Set guarenteed to contain all possible DisplaySetting values
appendCommandLine(net.dpml.cli.CommandLine) - method in class net.dpml.cli.commandline.DefaultingCommandLine
Adds a CommandLine instance to the back of the queue.
appendUsage(StringBuffer,Set,Comparator) - method in class net.dpml.cli.option.ArgumentImpl
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer,Set,Comparator) - method in class net.dpml.cli.option.Command
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer,Set,Comparator) - method in class net.dpml.cli.option.DefaultOption
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer,Set,Comparator) - method in class net.dpml.cli.option.GroupImpl
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer,Set,Comparator) - method in class net.dpml.cli.Option
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer,Set,Comparator) - method in class net.dpml.cli.option.ParentImpl
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer,Set,Comparator) - method in class net.dpml.cli.option.PropertyOption
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer,Set,Comparator) - method in class net.dpml.cli.option.SourceDestArgument
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer,Set,Comparator) - method in class net.dpml.cli.option.Switch
Appends usage information to the specified StringBuffer
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer,Set,Comparator,String) - method in class net.dpml.cli.option.GroupImpl
Appends usage information to the specified StringBuffer
Argument - interface net.dpml.cli.Argument
An Option that can process values passed on the command line in the form "--file README".
ARGUMENT_BUILDER_EMPTY_CONSUME_REMAINING - static field in class net.dpml.cli.resource.ResourceConstants
Empty consume remaining error constant.
ARGUMENT_BUILDER_EMPTY_NAME - static field in class net.dpml.cli.resource.ResourceConstants
Empty name error constant.
ARGUMENT_BUILDER_NEGATIVE_MAXIMUM - static field in class net.dpml.cli.resource.ResourceConstants
Negative maximum error constant.
ARGUMENT_BUILDER_NEGATIVE_MINIMUM - static field in class net.dpml.cli.resource.ResourceConstants
Negative minimum error constant.
ARGUMENT_BUILDER_NULL_CONSUME_REMAINING - static field in class net.dpml.cli.resource.ResourceConstants
Null consume remaining error constant.
ARGUMENT_BUILDER_NULL_DEFAULT - static field in class net.dpml.cli.resource.ResourceConstants
Null default error constant.
ARGUMENT_BUILDER_NULL_DEFAULTS - static field in class net.dpml.cli.resource.ResourceConstants
Null defaults error constant.
ARGUMENT_BUILDER_NULL_NAME - static field in class net.dpml.cli.resource.ResourceConstants
Null name error constant.
ARGUMENT_BUILDER_NULL_VALIDATOR - static field in class net.dpml.cli.resource.ResourceConstants
Null validator argument error constant.
ARGUMENT_MIN_EXCEEDS_MAX - static field in class net.dpml.cli.resource.ResourceConstants
Minimum greater than maximum error constant.
ARGUMENT_MISSING_VALUES - static field in class net.dpml.cli.resource.ResourceConstants
Missing argument error constant.
ARGUMENT_TOO_FEW_DEFAULTS - static field in class net.dpml.cli.resource.ResourceConstants
Too few defaults error constant.
ARGUMENT_TOO_MANY_DEFAULTS - static field in class net.dpml.cli.resource.ResourceConstants
Too many defaults error constant.
ARGUMENT_TOO_MANY_VALUES - static field in class net.dpml.cli.resource.ResourceConstants
Too many argument values error constant.
ARGUMENT_UNEXPECTED_VALUE - static field in class net.dpml.cli.resource.ResourceConstants
Unexpected argument value constant.
ArgumentBuilder - class net.dpml.cli.builder.ArgumentBuilder
Builds Argument instances.
ArgumentBuilder() - constructor for class net.dpml.cli.builder.ArgumentBuilder
Creates a new ArgumentBuilder instance
ArgumentImpl - class net.dpml.cli.option.ArgumentImpl
An implementation of an Argument.
Creates a new Argument instance.

C

CANNOT_BURST - static field in class net.dpml.cli.resource.ResourceConstants
Cannot burst error constant.
Indicates whether this Option will be able to process the particular argument.
Indicates whether this Option will be able to process the particular argument.
Indicates whether this Option will be able to process the particular argument.
Indicates whether this Option will be able to process the particular argument.
Indicates whether this Option will be able to process the particular argument.
Indicates whether this Option will be able to process the particular argument.
Indicates whether this Option will be able to process the particular argument.
Indicates whether this Option will be able to process the particular argument.
Indicates whether this Option will be able to process the particular argument.
chain(Comparator,Comparator) - static method in class net.dpml.cli.util.Comparators
Chains comparators together.
chain(Comparator,Comparator,Comparator) - static method in class net.dpml.cli.util.Comparators
Chains comparators together.
chain(Comparator,Comparator,Comparator,Comparator) - static method in class net.dpml.cli.util.Comparators
Chains comparators together.
Chains comparators together.
chain(Comparator[]) - static method in class net.dpml.cli.util.Comparators
Chains an array of comparators together.
chain(List) - static method in class net.dpml.cli.util.Comparators
Chains comparators together.
checkPrefixes(Set) - method in class net.dpml.cli.option.OptionImpl
Check prefixes.
ClassValidator - class net.dpml.cli.validation.ClassValidator
The ClassValidator validates the string argument values are class names.
CLASSVALIDATOR_BAD_CLASSNAME - static field in class net.dpml.cli.resource.ResourceConstants
Bad classname constant.
CLASSVALIDATOR_CLASS_ACCESS - static field in class net.dpml.cli.resource.ResourceConstants
Class access constant.
CLASSVALIDATOR_CLASS_CREATE - static field in class net.dpml.cli.resource.ResourceConstants
Class creation constant.
CLASSVALIDATOR_CLASS_NOTFOUND - static field in class net.dpml.cli.resource.ResourceConstants
Class not found constant.
Command - class net.dpml.cli.option.Command
Represents a cvs "update" style command line option.
Creates a new Command instance.
COMMAND_PREFERRED_NAME_TOO_SHORT - static field in class net.dpml.cli.resource.ResourceConstants
Preferenced commmand name too long error constant.
CommandBuilder - class net.dpml.cli.builder.CommandBuilder
Builds Command instances
CommandBuilder() - constructor for class net.dpml.cli.builder.CommandBuilder
Creates a new CommandBuilder instance.
commandFirst() - static method in class net.dpml.cli.util.Comparators
Forces Command instances to appear at the beginning of lists
commandLast() - static method in class net.dpml.cli.util.Comparators
Forces Command instances to appear at the end of lists
CommandLine - interface net.dpml.cli.CommandLine
Instances of CommandLine represent a command line that has been processed according to the definition supplied to the parser.
CommandLineImpl - class net.dpml.cli.commandline.CommandLineImpl
Instances of CommandLine represent a command line that has been processed according to the definition supplied to the parser.
commandLines() - method in class net.dpml.cli.commandline.DefaultingCommandLine
Builds an iterator over the build in CommandLines.
Comparators - class net.dpml.cli.util.Comparators
A collection of Comparators suitable for use with Option instances.
create() - method in class net.dpml.cli.builder.ArgumentBuilder
Creates a new Argument instance using the options specified in this ArgumentBuilder.
create() - method in class net.dpml.cli.builder.CommandBuilder
Creates a new Command instance using the properties of the CommandBuilder.
create() - method in class net.dpml.cli.builder.DefaultOptionBuilder
Creates a DefaultOption instance
create() - method in class net.dpml.cli.builder.GroupBuilder
Creates a new Group instance
create() - method in class net.dpml.cli.builder.PatternBuilder
Creates a new Option instance.
create() - method in class net.dpml.cli.builder.SwitchBuilder
Creates a new Switch instance

D

DateValidator - class net.dpml.cli.validation.DateValidator
The DateValidator validates the argument values are date or time value(s).
DateValidator() - constructor for class net.dpml.cli.validation.DateValidator
Creates a Validator for the default date/time format
DateValidator(DateFormat) - constructor for class net.dpml.cli.validation.DateValidator
Creates a Validator for the specified DateFormat.
DateValidator(List) - constructor for class net.dpml.cli.validation.DateValidator
Creates a Validator for the List of specified DateFormats.
DATEVALIDATOR_DATE_OUTOFRANGE - static field in class net.dpml.cli.resource.ResourceConstants
Date out of range constant.
DEFAULT_BURST_ENABLED - static field in class net.dpml.cli.option.DefaultOption
The default value for the burstEnabled constructor parameter
DEFAULT_CONSUME_REMAINING - static field in class net.dpml.cli.option.ArgumentImpl
The default token to indicate that remaining arguments should be consumed as values.
DEFAULT_DESCRIPTION - static field in class net.dpml.cli.option.PropertyOption
The default property option description.
DEFAULT_DESCRIPTION_WIDTH - static field in class net.dpml.cli.util.HelpFormatter
The default minimum description width.
DEFAULT_DISABLED_PREFIX - static field in class net.dpml.cli.option.Switch
The default prefix for disabled switches
DEFAULT_DISPLAY_USAGE_SETTINGS - static field in class net.dpml.cli.util.HelpFormatter
The default DisplaySettings used to select the help lines in the main body of help
DEFAULT_ENABLED_PREFIX - static field in class net.dpml.cli.option.Switch
The default prefix for enabled switches
DEFAULT_FULL_USAGE_SETTINGS - static field in class net.dpml.cli.util.HelpFormatter
The default DisplaySettings used to select the elements to display in the displayed line of full usage information.
DEFAULT_FULL_WIDTH - static field in class net.dpml.cli.util.HelpFormatter
The default screen width
DEFAULT_GUTTER_CENTER - static field in class net.dpml.cli.util.HelpFormatter
The default screen furniture right of screen
DEFAULT_GUTTER_LEFT - static field in class net.dpml.cli.util.HelpFormatter
The default screen furniture left of screen
DEFAULT_GUTTER_RIGHT - static field in class net.dpml.cli.util.HelpFormatter
The default screen furniture between columns
DEFAULT_INITIAL_SEPARATOR - static field in class net.dpml.cli.option.ArgumentImpl
The default value for the initial separator char.
DEFAULT_LINE_USAGE_SETTINGS - static field in class net.dpml.cli.util.HelpFormatter
The default DisplaySettings used to select the elements of usage per help line in the main body of help
DEFAULT_LONG_PREFIX - static field in class net.dpml.cli.option.DefaultOption
The default token used to prefix a long option
DEFAULT_OPTION_STRING - static field in class net.dpml.cli.option.PropertyOption
The default property option name.
DEFAULT_SHORT_PREFIX - static field in class net.dpml.cli.option.DefaultOption
The default token used to prefix a short option
DEFAULT_SUBSEQUENT_SEPARATOR - static field in class net.dpml.cli.option.ArgumentImpl
The default value for the subsequent separator char.
DefaultingCommandLine - class net.dpml.cli.commandline.DefaultingCommandLine
Manages a queue of default CommandLines.
DefaultOption - class net.dpml.cli.option.DefaultOption
A Parent implementation representing normal options.
Creates a new DefaultOption
DefaultOptionBuilder - class net.dpml.cli.builder.DefaultOptionBuilder
Builds DefaultOption instances.
DefaultOptionBuilder() - constructor for class net.dpml.cli.builder.DefaultOptionBuilder
Creates a new DefaultOptionBuilder using defaults
DefaultOptionBuilder(String,String,boolean) - constructor for class net.dpml.cli.builder.DefaultOptionBuilder
Creates a new DefaultOptionBuilder
defaultOptionFirst() - static method in class net.dpml.cli.util.Comparators
Forces DefaultOption instances to appear at the beginning of lists
defaultOptionLast() - static method in class net.dpml.cli.util.Comparators
Forces DefaultOption instances to appear at the end of lists
defaults(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.ArgumentImpl
Adds defaults to a CommandLine.
defaults(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.GroupImpl
Process defaults.
Adds defaults to a CommandLine.
defaults(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.OptionImpl
Adds defaults to a CommandLine.
defaults(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.ParentImpl
Adds defaults to a CommandLine.
defaults(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.Switch
Adds defaults to a CommandLine.
Adds defaults to a CommandLine.
Adds defaults to a CommandLine.
DISPLAY_ALIASES - static field in class net.dpml.cli.DisplaySetting
Indicates that aliases should be included
DISPLAY_ARGUMENT_BRACKETED - static field in class net.dpml.cli.DisplaySetting
Indicates that arguments should be included bracketed
DISPLAY_ARGUMENT_NUMBERED - static field in class net.dpml.cli.DisplaySetting
Indicates that arguments should be included numbered
DISPLAY_GROUP_ARGUMENT - static field in class net.dpml.cli.DisplaySetting
Indicates that group arguments should be included
DISPLAY_GROUP_EXPANDED - static field in class net.dpml.cli.DisplaySetting
Indicates that groups should be included expanded
DISPLAY_GROUP_NAME - static field in class net.dpml.cli.DisplaySetting
Indicates that group names should be included
DISPLAY_GROUP_OUTER - static field in class net.dpml.cli.DisplaySetting
Indicates that group outer brackets should be included
DISPLAY_OPTIONAL - static field in class net.dpml.cli.DisplaySetting
Indicates that optionality should be included
DISPLAY_PARENT_ARGUMENT - static field in class net.dpml.cli.DisplaySetting
Indicates that arguments of Parents should be included
DISPLAY_PARENT_CHILDREN - static field in class net.dpml.cli.DisplaySetting
Indicates that children of Parents should be included
DISPLAY_PROPERTY_OPTION - static field in class net.dpml.cli.DisplaySetting
Indicates that property options should be included
DISPLAY_SWITCH_DISABLED - static field in class net.dpml.cli.DisplaySetting
Indicates that switches should be included disabled
DISPLAY_SWITCH_ENABLED - static field in class net.dpml.cli.DisplaySetting
Indicates that switches should be included enabled
DisplaySetting - class net.dpml.cli.DisplaySetting
An enum of possible display settings.

E

ENUM_ILLEGAL_VALUE - static field in class net.dpml.cli.resource.ResourceConstants
Illegal emumeration value error constant.
EnumValidator - class net.dpml.cli.validation.EnumValidator
The EnumValidator validates the string argument values are valid.
EnumValidator(Set) - constructor for class net.dpml.cli.validation.EnumValidator
Creates a new EnumValidator for the specified values.
equals(Object) - method in class net.dpml.cli.DisplaySetting
Test this object for equality with the supplied object.
equals(Object) - method in class net.dpml.cli.option.OptionImpl
Evaluate this instance against the supplied instance for equality.

F

FileValidator - class net.dpml.cli.validation.FileValidator
The FileValidator validates the string argument values are files.
findOption(String) - method in class net.dpml.cli.option.GroupImpl
Recursively searches for an option with the supplied trigger.
findOption(String) - method in class net.dpml.cli.Option
Recursively searches for an option with the supplied trigger.
findOption(String) - method in class net.dpml.cli.option.OptionImpl
Recursively searches for an option with the supplied trigger.
findOption(String) - method in class net.dpml.cli.option.ParentImpl
Recursively searches for an option with the supplied trigger.

G

getAnonymous() - method in class net.dpml.cli.option.GroupImpl
Gets the m_anonymous Arguments of this Group.
getArgument() - method in class net.dpml.cli.option.ParentImpl
Return the argument value if any.
getBundleName() - method in class net.dpml.cli.resource.ResourceHelper
Return the resource bundle name.
getChildren() - method in class net.dpml.cli.option.ParentImpl
Return any children.
getClassLoader() - method in class net.dpml.cli.validation.ClassValidator
Returns the ClassLoader used to resolve and load the classes specified by the argument values.
getComparator() - method in class net.dpml.cli.util.HelpFormatter
Return the comparator.
getConsumeRemaining() - method in class net.dpml.cli.option.ArgumentImpl
Return the consume remaining flag.
getCurrencyInstance() - static method in class net.dpml.cli.validation.NumberValidator
Returns a NumberValidator for a currency format for the current default locale.
getDateInstance() - static method in class net.dpml.cli.validation.DateValidator
Creates a Validator for dates.
getDateTimeInstance() - static method in class net.dpml.cli.validation.DateValidator
Creates a Validator for date/times
getDefaultValues() - method in class net.dpml.cli.option.ArgumentImpl
Return the list of default values.
getDescription() - method in class net.dpml.cli.option.ArgumentImpl
Returns a description of the option.
getDescription() - method in class net.dpml.cli.option.GroupImpl
Returns a description of the option.
getDescription() - method in class net.dpml.cli.HelpLine
getDescription() - method in class net.dpml.cli.option.HelpLineImpl
getDescription() - method in class net.dpml.cli.Option
Returns a description of the option.
getDescription() - method in class net.dpml.cli.option.ParentImpl
Returns a description of the option.
getDescription() - method in class net.dpml.cli.option.PropertyOption
Returns a description of the option.
getDisplaySettings() - method in class net.dpml.cli.util.HelpFormatter
Return the display settings.
getDivider() - method in class net.dpml.cli.util.HelpFormatter
Return the divider.
getException() - method in class net.dpml.cli.util.HelpFormatter
Return the option exception
getExistingDirectoryInstance() - static method in class net.dpml.cli.validation.FileValidator
Returns a FileValidator for existing directories.
getExistingFileInstance() - static method in class net.dpml.cli.validation.FileValidator
Returns a FileValidator for existing files.
getExistingInstance() - static method in class net.dpml.cli.validation.FileValidator
Returns a FileValidator for existing files/directories.
getFooter() - method in class net.dpml.cli.util.HelpFormatter
Return the footer text.
getFormat() - method in class net.dpml.cli.validation.NumberValidator
Return the format being used to validate argument values against.
getFormats() - method in class net.dpml.cli.validation.DateValidator
Gets the date formats permitted.
getFullUsageSettings() - method in class net.dpml.cli.util.HelpFormatter
Return the full usage display settings.
getGroup() - method in class net.dpml.cli.util.HelpFormatter
Return the group.
getGutterCenter() - method in class net.dpml.cli.util.HelpFormatter
Return the gutter center string.
getGutterLeft() - method in class net.dpml.cli.util.HelpFormatter
Return the gutter left string.
getGutterRight() - method in class net.dpml.cli.util.HelpFormatter
Return the gutter right string.
getHeader() - method in class net.dpml.cli.util.HelpFormatter
Return the header string.
getId() - method in class net.dpml.cli.Option
Returns the id of the option.
getId() - method in class net.dpml.cli.option.OptionImpl
Returns the id of the option.
getIndent() - method in class net.dpml.cli.HelpLine
getIndent() - method in class net.dpml.cli.option.HelpLineImpl
getInitialSeparator() - method in class net.dpml.cli.Argument
Returns the initial separator character or '\0' if no character has been set.
getInitialSeparator() - method in class net.dpml.cli.option.ArgumentImpl
Returns the initial separator character or '\0' if no character has been set.
getIntegerInstance() - static method in class net.dpml.cli.validation.NumberValidator
Returns a NumberValidator for an integer number format for the current default locale.
getLineUsageSettings() - method in class net.dpml.cli.util.HelpFormatter
Return the line usage settings.
getMaximum() - method in class net.dpml.cli.Argument
Retrieves the maximum number of values acceptable for a valid Argument
getMaximum() - method in class net.dpml.cli.option.ArgumentImpl
Retrieves the maximum number of values acceptable for a valid Argument
getMaximum() - method in class net.dpml.cli.validation.DateValidator
Returns the maximum date permitted.
getMaximum() - method in class net.dpml.cli.Group
Retrieves the maximum number of members acceptable for a valid Group
getMaximum() - method in class net.dpml.cli.option.GroupImpl
Retrieves the maximum number of values acceptable for a valid Argument
getMaximum() - method in class net.dpml.cli.validation.NumberValidator
Return the maximum value allowed for an argument value.
getMessage() - method in class net.dpml.cli.OptionException
Return the exception message.
getMessage(String) - method in class net.dpml.cli.resource.ResourceHelper
Returns the message for the specified key.
getMessage(String,Object) - method in class net.dpml.cli.resource.ResourceHelper
Returns the message for the specified key and argument.
getMessage(String,Object,Object) - method in class net.dpml.cli.resource.ResourceHelper
Returns the message for the specified key and arguments.
getMessage(String,Object,Object,Object) - method in class net.dpml.cli.resource.ResourceHelper
Returns the message for the specified key and arguments.
getMessage(String,Object[]) - method in class net.dpml.cli.resource.ResourceHelper
Returns the message for the specified key and arguments.
getMinimum() - method in class net.dpml.cli.Argument
Retrieves the minimum number of values required for a valid Argument
getMinimum() - method in class net.dpml.cli.option.ArgumentImpl
Retrieves the minimum number of values required for a valid Argument
getMinimum() - method in class net.dpml.cli.validation.DateValidator
Returns the minimum date permitted.
getMinimum() - method in class net.dpml.cli.Group
Retrieves the minimum number of members required for a valid Group
getMinimum() - method in class net.dpml.cli.option.GroupImpl
Retrieves the minimum number of values required for a valid Argument
getMinimum() - method in class net.dpml.cli.validation.NumberValidator
Return the minimum value allowed for an argument value.
getNormalised() - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Return the normalized collection.
getNumberInstance() - static method in class net.dpml.cli.validation.NumberValidator
Returns a NumberValidator for a general-purpose number format for the current default locale.
getOption() - method in class net.dpml.cli.HelpLine
getOption() - method in class net.dpml.cli.option.HelpLineImpl
getOption() - method in class net.dpml.cli.OptionException
Gets the Option the exception relates to
getOption(String) - method in class net.dpml.cli.CommandLine
Finds the Option with the specified trigger
getOption(String) - method in class net.dpml.cli.commandline.DefaultingCommandLine
Finds the Option with the specified trigger
getOption(String) - method in class net.dpml.cli.commandline.PreferencesCommandLine
Finds the Option with the specified trigger
getOption(String) - method in class net.dpml.cli.commandline.PropertiesCommandLine
Finds the Option with the specified trigger
getOption(String) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Finds the Option with the specified trigger
getOptionCount(net.dpml.cli.Option) - method in class net.dpml.cli.CommandLine
Retrieves the number of times the specified Option appeared in this CommandLine
getOptionCount(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the number of times the specified Option appeared in this CommandLine
getOptionCount(String) - method in class net.dpml.cli.CommandLine
Retrieves the number of times the specified Option appeared in this CommandLine
getOptionCount(String) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the number of times the specified Option appeared in this CommandLine
getOptions() - method in class net.dpml.cli.CommandLine
Retrieves a list of all Options found in this CommandLine
getOptions() - method in class net.dpml.cli.commandline.DefaultingCommandLine
Retrieves a list of all Options found in this CommandLine
getOptions() - method in class net.dpml.cli.option.GroupImpl
Gets the member Options of thie Group.
getOptions() - method in class net.dpml.cli.commandline.PreferencesCommandLine
Retrieves a list of all Options found in this CommandLine
getOptions() - method in class net.dpml.cli.commandline.PropertiesCommandLine
Retrieves a list of all Options found in this CommandLine
getOptions() - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Retrieves a list of all Options found in this CommandLine
getOptionTriggers() - method in class net.dpml.cli.CommandLine
Retrieves a list of all Option triggers found in this CommandLine
getOptionTriggers() - method in class net.dpml.cli.commandline.DefaultingCommandLine
Retrieves a list of all Option triggers found in this CommandLine
getOptionTriggers() - method in class net.dpml.cli.commandline.PreferencesCommandLine
Retrieves a list of all Option triggers found in this CommandLine
getOptionTriggers() - method in class net.dpml.cli.commandline.PropertiesCommandLine
Retrieves a list of all Option triggers found in this CommandLine
getOptionTriggers() - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Retrieves a list of all Option triggers found in this CommandLine
getPageWidth() - method in class net.dpml.cli.util.HelpFormatter
Return the page width.
getPercentInstance() - static method in class net.dpml.cli.validation.NumberValidator
Returns a NumberValidator for a percentage format for the current default locale.
getPreferredName() - method in class net.dpml.cli.option.ArgumentImpl
The preferred name of an option is used for generating help and usage information.
getPreferredName() - method in class net.dpml.cli.option.Command
The preferred name of an option is used for generating help and usage information.
getPreferredName() - method in class net.dpml.cli.option.DefaultOption
The preferred name of an option is used for generating help and usage information.
getPreferredName() - method in class net.dpml.cli.option.GroupImpl
The preferred name of an option is used for generating help and usage information.
getPreferredName() - method in class net.dpml.cli.Option
The preferred name of an option is used for generating help and usage information.
getPreferredName() - method in class net.dpml.cli.option.PropertyOption
The preferred name of an option is used for generating help and usage information.
getPreferredName() - method in class net.dpml.cli.option.Switch
The preferred name of an option is used for generating help and usage information.
getPrefixes() - method in class net.dpml.cli.option.ArgumentImpl
Identifies the argument prefixes that should be considered options.
getPrefixes() - method in class net.dpml.cli.option.DefaultOption
Identifies the argument prefixes that should be considered options.
getPrefixes() - method in class net.dpml.cli.option.GroupImpl
Identifies the argument prefixes that should be considered options.
getPrefixes() - method in class net.dpml.cli.Option
Identifies the argument prefixes that should be considered options.
getPrefixes() - method in class net.dpml.cli.option.ParentImpl
Identifies the argument prefixes that should be considered options.
getPrefixes() - method in class net.dpml.cli.option.PropertyOption
Identifies the argument prefixes that should be considered options.
getPrefixes() - method in class net.dpml.cli.option.Switch
Identifies the argument prefixes that should be considered options.
getPrintWriter() - method in class net.dpml.cli.util.HelpFormatter
Return the print writer.
getProperties() - method in class net.dpml.cli.CommandLine
Retrieves the set of all property names associated with this CommandLine
getProperties() - method in class net.dpml.cli.commandline.DefaultingCommandLine
Retrieves the set of all property names associated with this CommandLine
getProperties() - method in class net.dpml.cli.commandline.PreferencesCommandLine
Retrieves the set of all property names associated with this CommandLine
getProperties() - method in class net.dpml.cli.commandline.PropertiesCommandLine
Retrieves the set of all property names associated with this CommandLine
getProperties() - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Retrieves the set of all property names associated with this CommandLine
getProperty(String) - method in class net.dpml.cli.CommandLine
Retrieves the value associated with the specified property
getProperty(String) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the value associated with the specified property
getProperty(String,String) - method in class net.dpml.cli.CommandLine
Retrieves the value associated with the specified property
getProperty(String,String) - method in class net.dpml.cli.commandline.DefaultingCommandLine
Retrieves the value associated with the specified property
getProperty(String,String) - method in class net.dpml.cli.commandline.PreferencesCommandLine
Retrieves the value associated with the specified property
getProperty(String,String) - method in class net.dpml.cli.commandline.PropertiesCommandLine
Retrieves the value associated with the specified property
getProperty(String,String) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Retrieves the value associated with the specified property
getProtocol() - method in class net.dpml.cli.validation.URLValidator
Returns the protocol that must be used by a valid URL.
getResourceHelper() - static method in class net.dpml.cli.resource.ResourceHelper
Gets the ResourceHelper appropriate to the specified class.
getShellCommand() - method in class net.dpml.cli.util.HelpFormatter
Return the shell command.
getSubsequentSeparator() - method in class net.dpml.cli.option.ArgumentImpl
Returns the subsequent separator character.
getSwitch(net.dpml.cli.Option) - method in class net.dpml.cli.CommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the Boolean value associated with the specified Switch
Retrieves the Boolean value associated with the specified Switch
getSwitch(net.dpml.cli.Option,Boolean) - method in class net.dpml.cli.commandline.DefaultingCommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(net.dpml.cli.Option,Boolean) - method in class net.dpml.cli.commandline.PreferencesCommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(net.dpml.cli.Option,Boolean) - method in class net.dpml.cli.commandline.PropertiesCommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(net.dpml.cli.Option,Boolean) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Retrieves the Boolean value associated with the specified Switch
getSwitch(String) - method in class net.dpml.cli.CommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(String) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the Boolean value associated with the specified Switch
getSwitch(String,Boolean) - method in class net.dpml.cli.CommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(String,Boolean) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the Boolean value associated with the specified Switch
getTimeInstance() - static method in class net.dpml.cli.validation.DateValidator
Creates a Validator for times.
getTriggers() - method in class net.dpml.cli.option.ArgumentImpl
Identifies the argument prefixes that should trigger this option.
getTriggers() - method in class net.dpml.cli.option.Command
Identifies the argument prefixes that should trigger this option.
getTriggers() - method in class net.dpml.cli.option.DefaultOption
Identifies the argument prefixes that should trigger this option.
getTriggers() - method in class net.dpml.cli.option.GroupImpl
Identifies the argument prefixes that should trigger this option.
getTriggers() - method in class net.dpml.cli.Option
Identifies the argument prefixes that should trigger this option.
getTriggers() - method in class net.dpml.cli.option.PropertyOption
Identifies the argument prefixes that should trigger this option.
getTriggers() - method in class net.dpml.cli.option.Switch
Identifies the argument prefixes that should trigger this option.
getValidator() - method in class net.dpml.cli.option.ArgumentImpl
Return the argument validator.
getValidValues() - method in class net.dpml.cli.validation.EnumValidator
Returns the Set of valid argument values.
getValue(net.dpml.cli.Option) - method in class net.dpml.cli.CommandLine
Retrieves the single Argument value associated with the specified Option
getValue(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the single Argument value associated with the specified Option
getValue(net.dpml.cli.Option,Object) - method in class net.dpml.cli.CommandLine
Retrieves the single Argument value associated with the specified Option
getValue(net.dpml.cli.Option,Object) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the single Argument value associated with the specified Option
getValue(String) - method in class net.dpml.cli.CommandLine
Retrieves the single Argument value associated with the specified Option
getValue(String) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the single Argument value associated with the specified Option
getValue(String,Object) - method in class net.dpml.cli.CommandLine
Retrieves the single Argument value associated with the specified Option
getValue(String,Object) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the single Argument value associated with the specified Option
getValues(net.dpml.cli.Option) - method in class net.dpml.cli.CommandLine
Retrieves the Argument values associated with the specified Option
getValues(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the Argument values associated with the specified Option
getValues(net.dpml.cli.Option,List) - method in class net.dpml.cli.CommandLine
Retrieves the Argument values associated with the specified Option
getValues(net.dpml.cli.Option,List) - method in class net.dpml.cli.commandline.DefaultingCommandLine
Retrieves the Argument values associated with the specified Option
getValues(net.dpml.cli.Option,List) - method in class net.dpml.cli.commandline.PreferencesCommandLine
Retrieves the Argument values associated with the specified Option
getValues(net.dpml.cli.Option,List) - method in class net.dpml.cli.commandline.PropertiesCommandLine
Retrieves the Argument values associated with the specified Option
getValues(net.dpml.cli.Option,List) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Retrieves the Argument values associated with the specified Option
getValues(String) - method in class net.dpml.cli.CommandLine
Retrieves the Argument values associated with the specified Option
getValues(String) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the Argument values associated with the specified Option
getValues(String,List) - method in class net.dpml.cli.CommandLine
Retrieves the Argument values associated with the specified Option
getValues(String,List) - method in class net.dpml.cli.commandline.CommandLineImpl
Retrieves the Argument values associated with the specified Option
Group - interface net.dpml.cli.Group
An Option representing a choice or group of Options in the form "-a|-b|-c".
GroupBuilder - class net.dpml.cli.builder.GroupBuilder
Builds Group instances.
GroupBuilder() - constructor for class net.dpml.cli.builder.GroupBuilder
Creates a new GroupBuilder
groupFirst() - static method in class net.dpml.cli.util.Comparators
Forces Group instances to appear at the beginning of lists
GroupImpl - class net.dpml.cli.option.GroupImpl
An implementation of Group
GroupImpl(List,String,String,int,int) - constructor for class net.dpml.cli.option.GroupImpl
Creates a new GroupImpl using the specified parameters.
groupLast() - static method in class net.dpml.cli.util.Comparators
Forces Group instances to appear at the end of lists

H

hashCode() - method in class net.dpml.cli.DisplaySetting
Return the instance hashcode value.
hashCode() - method in class net.dpml.cli.option.OptionImpl
Return the hashcode value for this instance.
hasOption(net.dpml.cli.Option) - method in class net.dpml.cli.CommandLine
Detects the presence of an option in this CommandLine.
hasOption(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.DefaultingCommandLine
Detects the presence of an option in this CommandLine.
hasOption(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.PreferencesCommandLine
Detects the presence of an option in this CommandLine.
hasOption(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.PropertiesCommandLine
Detects the presence of an option in this CommandLine.
hasOption(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Detects the presence of an option in this CommandLine.
hasOption(String) - method in class net.dpml.cli.CommandLine
Detects the presence of an option with the specified trigger in this CommandLine.
hasOption(String) - method in class net.dpml.cli.commandline.CommandLineImpl
Detects the presence of an option with the specified trigger in this CommandLine.
HELP_SETTINGS - static field in class net.dpml.cli.OptionException
The settings used when displaying the related Option.
HelpFormatter - class net.dpml.cli.util.HelpFormatter
Presents on screen help based on the application's Options
HelpFormatter() - constructor for class net.dpml.cli.util.HelpFormatter
Creates a new HelpFormatter using the defaults
HelpFormatter(String,String,String,int) - constructor for class net.dpml.cli.util.HelpFormatter
Creates a new HelpFormatter using the specified parameters
HelpFormatter(String,String,String,int,int) - constructor for class net.dpml.cli.util.HelpFormatter
Creates a new HelpFormatter using the specified parameters
HELPFORMATTER_GUTTER_TOO_LONG - static field in class net.dpml.cli.resource.ResourceConstants
Gutter too long error constant.
HELPFORMATTER_WIDTH_TOO_NARROW - static field in class net.dpml.cli.resource.ResourceConstants
Width too narrow error constant.
HelpLine - interface net.dpml.cli.HelpLine
Represents a line of help for a particular Option.
HelpLineImpl - class net.dpml.cli.option.HelpLineImpl
Represents a line in the help screen.
HelpLineImpl(net.dpml.cli.Option,int) - constructor for class net.dpml.cli.option.HelpLineImpl
Creates a new HelpLineImpl to represent a particular Option in the online help.
helpLines(int,Set,Comparator) - method in class net.dpml.cli.option.ArgumentImpl
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
helpLines(int,Set,Comparator) - method in class net.dpml.cli.option.GroupImpl
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
helpLines(int,Set,Comparator) - method in class net.dpml.cli.Option
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
helpLines(int,Set,Comparator) - method in class net.dpml.cli.option.ParentImpl
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
helpLines(int,Set,Comparator) - method in class net.dpml.cli.option.PropertyOption
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
helpLines(int,Set,Comparator) - method in class net.dpml.cli.option.SourceDestArgument
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.

I

Adds a CommandLine instance to a specified position in the queue.
INSTANCE - static field in class net.dpml.cli.option.PropertyOption
A default PropertyOption instance
InvalidArgumentException - class net.dpml.cli.validation.InvalidArgumentException
An exception indicating validation failure.
InvalidArgumentException(String) - constructor for class net.dpml.cli.validation.InvalidArgumentException
Creates a new exception
isDirectory() - method in class net.dpml.cli.validation.FileValidator
Returns whether the argument values must represent directories.
isExisting() - method in class net.dpml.cli.validation.FileValidator
Returns whether the argument values must represent existing files/directories.
isFile() - method in class net.dpml.cli.validation.FileValidator
Returns whether the argument values must represent directories.
isInstance() - method in class net.dpml.cli.validation.ClassValidator
Returns whether the argument value must represent a class that can be instantiated.
isLeniant() - method in class net.dpml.cli.validation.DateValidator
Return the leaniant flag.
isLoadable() - method in class net.dpml.cli.validation.ClassValidator
Returns whether the argument value must represent a class that is loadable.
isPotentialClassName(String) - method in class net.dpml.cli.validation.ClassValidator
Returns whether the specified name is allowed as a Java class name.
isRequired() - method in class net.dpml.cli.Argument
Indicates whether argument values must be present for the CommandLine to be valid.
isRequired() - method in class net.dpml.cli.option.ArgumentImpl
Indicates whether argument values must be present for the CommandLine to be valid.
isRequired() - method in class net.dpml.cli.Group
Indicates whether group members must be present for the CommandLine to be valid.
isRequired() - method in class net.dpml.cli.option.GroupImpl
Indicates whether argument values must be present for the CommandLine to be valid.
isRequired() - method in class net.dpml.cli.Option
Indicates whether this option is required to be present.
isRequired() - method in class net.dpml.cli.option.OptionImpl
Indicates whether this option is required to be present.

L

looksLikeOption(String) - method in class net.dpml.cli.WriteableCommandLine
Detects whether the argument looks like an Option trigger
looksLikeOption(String) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Return true if the trigger argument looks like an option.

M

MISSING_OPTION - static field in class net.dpml.cli.resource.ResourceConstants
Missing option error constant.

N

namedFirst(String) - static method in class net.dpml.cli.util.Comparators
Forces Comparators with a particular trigger to appear at the beginning of lists
namedLast(String) - static method in class net.dpml.cli.util.Comparators
Forces Comparators with a particular trigger to appear at the end of lists
net.dpml.cli - package
Commandline modeling and parsing utilities.
Helpers supporting the construction of a commandline model.
Commandline implementation.
Options implementation include command, group, switch and property abstractions.
Internationalization resources.
Commandline utilities including help formatter.
Provides classes and interfaces for validating argument values.
NONE - static field in class net.dpml.cli.DisplaySetting
A Set guarenteed to contain no DisplaySetting values
NumberValidator - class net.dpml.cli.validation.NumberValidator
The NumberValidator validates the string argument values are numbers.
NumberValidator(NumberFormat) - constructor for class net.dpml.cli.validation.NumberValidator
Creates a new NumberValidator based on the specified NumberFormat
NUMBERVALIDATOR_NUMBER_OUTOFRANGE - static field in class net.dpml.cli.resource.ResourceConstants
Number out-of-range constant.

O

Option - interface net.dpml.cli.Option
The super type of all options representing a particular element of the command line interface.
OPTION_ILLEGAL_LONG_PREFIX - static field in class net.dpml.cli.resource.ResourceConstants
Illegal long prefix error constant.
OPTION_ILLEGAL_SHORT_PREFIX - static field in class net.dpml.cli.resource.ResourceConstants
Illegal short prefix error constant.
OPTION_MISSING_REQUIRED - static field in class net.dpml.cli.resource.ResourceConstants
Missing required option error constant.
OPTION_NO_NAME - static field in class net.dpml.cli.resource.ResourceConstants
Missing option name error constant.
OPTION_TRIGGER_NEEDS_PREFIX - static field in class net.dpml.cli.resource.ResourceConstants
Missing trigger prefix error constant.
OptionException - class net.dpml.cli.OptionException
A problem found while dealing with command line options.
OptionException(net.dpml.cli.Option) - constructor for class net.dpml.cli.OptionException
Creates a new OptionException.
Creates a new OptionException.
Creates a new OptionException.
OptionImpl - class net.dpml.cli.option.OptionImpl
A base implementation of Option providing limited ground work for further Option implementations.
OptionImpl(int,boolean) - constructor for class net.dpml.cli.option.OptionImpl
Creates an OptionImpl with the specified id

P

pad(String,int,Writer) - static method in class net.dpml.cli.util.HelpFormatter
Pad the supplied string.
Parent - interface net.dpml.cli.Parent
An Option that can have an argument and/or group of child Options in the form "-f <arg> [-a|-b|-c]".
ParentImpl - class net.dpml.cli.option.ParentImpl
A base implementation of Parent providing limited ground work for further Parent implementations.
Creation of a new ParaentImpl.
parse(String[]) - method in class net.dpml.cli.commandline.Parser
Parse the arguments according to the specified options and properties.
parseAndHelp(String[]) - method in class net.dpml.cli.commandline.Parser
Parse the arguments according to the specified options and properties and displays the usage screen if the CommandLine is not valid or the help option was specified.
Parser - class net.dpml.cli.commandline.Parser
A class that implements the Parser interface can parse a String array according to the Groupspecified and return a CommandLine.
PatternBuilder - class net.dpml.cli.builder.PatternBuilder
Builds Options using a String pattern
PatternBuilder() - constructor for class net.dpml.cli.builder.PatternBuilder
Creates a new PatternBuilder
Creates a new PatternBuilder
PreferencesCommandLine - class net.dpml.cli.commandline.PreferencesCommandLine
A CommandLine implementation using the Preferences API, useful when constructing a complex DefaultingCommandLine This implementation uses the children of a single preference node to populate the CommandLine.
Creates a new PreferencesCommandLine using the specified root Option and Preferences node.
Creates a new PreferencesCommandLine using the specified root Option, Preferences node and value separator.
preferredNameFirst() - static method in class net.dpml.cli.util.Comparators
Orders Options by preferredName
preferredNameLast() - static method in class net.dpml.cli.util.Comparators
Orders Options by preferredName, reversed
print() - method in class net.dpml.cli.util.HelpFormatter
Prints the Option help.
printDivider() - method in class net.dpml.cli.util.HelpFormatter
Prints the m_divider text
printException() - method in class net.dpml.cli.util.HelpFormatter
Prints any error message.
printFooter() - method in class net.dpml.cli.util.HelpFormatter
Prints a m_footer string if necessary
printGutterLeft() - method in class net.dpml.cli.util.HelpFormatter
Prints the left gutter string
printGutterRight() - method in class net.dpml.cli.util.HelpFormatter
Prints the right gutter string
printHeader() - method in class net.dpml.cli.util.HelpFormatter
Prints a m_header string if necessary
printHelp() - method in class net.dpml.cli.util.HelpFormatter
Prints detailed help per option.
printUsage() - method in class net.dpml.cli.util.HelpFormatter
Prints a single line of usage information (wrapping if necessary)
printWrapped(String) - method in class net.dpml.cli.util.HelpFormatter
Prints a string wrapped if necessary
Processes String arguments into a CommandLine.
Processes String arguments into a CommandLine.
Processes String arguments into a CommandLine.
Processes String arguments into a CommandLine.
Processes String arguments into a CommandLine.
Process the parent.
Process the parent.
Processes the parent part of the Option.
Processes the parent part of the Option.
Processes the "README" style element of the argument.
Processes the "README" style element of the argument.
PropertiesCommandLine - class net.dpml.cli.commandline.PropertiesCommandLine
A CommandLine implementation using a java Properties instance, useful for constructing a complex DefaultingCommandLine Options are keyed from their property name and presence in the Properties instance is taken as presence in the CommandLine.
PropertiesCommandLine(net.dpml.cli.Option,Properties) - constructor for class net.dpml.cli.commandline.PropertiesCommandLine
Creates a new PropertiesCommandLine using the specified root Option, Properties instance.
Creates a new PropertiesCommandLine using the specified root Option, Properties instance and value separator.
PropertyOption - class net.dpml.cli.option.PropertyOption
Handles the java style "-Dprop=value" opions
PropertyOption() - constructor for class net.dpml.cli.option.PropertyOption
Creates a new PropertyOption using the default settings of a "-D" trigger and an id of 'D'
PropertyOption(String,String,int) - constructor for class net.dpml.cli.option.PropertyOption
Creates a new PropertyOption using the specified parameters

R

requiredFirst() - static method in class net.dpml.cli.util.Comparators
Orders Options grouping required Options first
requiredLast() - static method in class net.dpml.cli.util.Comparators
Orders Options grouping required Options last
reset() - method in class net.dpml.cli.builder.ArgumentBuilder
Resets the ArgumentBuilder to the defaults for a new Argument.
reset() - method in class net.dpml.cli.builder.CommandBuilder
Resets the CommandBuilder to the defaults for a new Command.
reset() - method in class net.dpml.cli.builder.DefaultOptionBuilder
Resets the builder.
reset() - method in class net.dpml.cli.builder.GroupBuilder
Resets the builder
reset() - method in class net.dpml.cli.builder.PatternBuilder
Resets this builder
reset() - method in class net.dpml.cli.builder.SwitchBuilder
Resets the builder.
ResourceConstants - class net.dpml.cli.resource.ResourceConstants
Common resurce constants.
ResourceHelper - class net.dpml.cli.resource.ResourceHelper
A utility class used to provide internationalisation support.
RESOURCES - static field in class net.dpml.cli.option.Switch
i18n

S

setClassLoader(ClassLoader) - method in class net.dpml.cli.validation.ClassValidator
Specifies the ClassLoader used to resolve and load the classes specified by the argument values.
setComparator(Comparator) - method in class net.dpml.cli.util.HelpFormatter
The Comparator to use when sorting Options
Sets the default state for a Switch in the CommandLine.
Set default switch.
Sets the default values for an Option in the CommandLine
setDefaultValues(net.dpml.cli.Option,List) - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Set default values.
setDirectory(boolean) - method in class net.dpml.cli.validation.FileValidator
Specifies whether the argument values must represent directories.
setDisplaySettings(Set) - method in class net.dpml.cli.util.HelpFormatter
The DisplaySettings used to select the help lines in the main body of help
setDivider(String) - method in class net.dpml.cli.util.HelpFormatter
Sets the string to use as a m_divider between sections of help
setException(net.dpml.cli.OptionException) - method in class net.dpml.cli.util.HelpFormatter
Sets the exception to document
setExisting(boolean) - method in class net.dpml.cli.validation.FileValidator
Specifies whether the argument values must represent existing files/directories.
setFile(boolean) - method in class net.dpml.cli.validation.FileValidator
Specifies whether the argument values must represent files.
setFooter(String) - method in class net.dpml.cli.util.HelpFormatter
Sets the footer text of the help screen
setFormat(DateFormat) - method in class net.dpml.cli.validation.DateValidator
Sets the date format permitted.
setFormat(NumberFormat) - method in class net.dpml.cli.validation.NumberValidator
Specify the format being used to validate argument values against.
setFormats(DateFormat[]) - method in class net.dpml.cli.validation.DateValidator
Sets the date formats permitted.
setFormats(List) - method in class net.dpml.cli.validation.DateValidator
Sets the date formats permitted.
setFullUsageSettings(Set) - method in class net.dpml.cli.util.HelpFormatter
The DisplaySettings used to select the elements to display in the displayed line of full usage information.
setGroup(net.dpml.cli.Group) - method in class net.dpml.cli.util.HelpFormatter
Sets the Group of Options to document
setGroup(net.dpml.cli.Group) - method in class net.dpml.cli.commandline.Parser
Sets the Group of options to parse against
setHeader(String) - method in class net.dpml.cli.util.HelpFormatter
Sets the header text of the help screen
setHelpFormatter(net.dpml.cli.util.HelpFormatter) - method in class net.dpml.cli.commandline.Parser
Sets the HelpFormatter to use with the simplified parsing.
setHelpOption(net.dpml.cli.Option) - method in class net.dpml.cli.commandline.Parser
Sets the help option to use with the simplified parsing.
setHelpTrigger(String) - method in class net.dpml.cli.commandline.Parser
Sets the help option to use with the simplified parsing.
setInstance(boolean) - method in class net.dpml.cli.validation.ClassValidator
Specifies whether the argument value must represent a class that can be instantiated.
setLeniant(boolean) - method in class net.dpml.cli.validation.DateValidator
Set the leaniant flag.
setLineUsageSettings(Set) - method in class net.dpml.cli.util.HelpFormatter
Sets the DisplaySettings used to select elements in the per helpline usage strings.
setLoadable(boolean) - method in class net.dpml.cli.validation.ClassValidator
Specifies whether the argument value must represent a class that is loadable.
setMaximum(Date) - method in class net.dpml.cli.validation.DateValidator
Sets the maximum Date to the specified value.
setMaximum(Number) - method in class net.dpml.cli.validation.NumberValidator
Specify the maximum value allowed for an argument value.
setMinimum(Date) - method in class net.dpml.cli.validation.DateValidator
Sets the minimum Date to the specified value.
setMinimum(Number) - method in class net.dpml.cli.validation.NumberValidator
Specify the minimum value allowed for an argument value.
setPrintWriter(PrintWriter) - method in class net.dpml.cli.util.HelpFormatter
Set the print writer.
setProtocol(String) - method in class net.dpml.cli.validation.URLValidator
Specifies the protocol that a URL must have to be valid.
setShellCommand(String) - method in class net.dpml.cli.util.HelpFormatter
Sets the command string used to invoke the application
setValidValues(Set) - method in class net.dpml.cli.validation.EnumValidator
Specifies the Set of valid argument values.
SOURCE_DEST_MUST_ENFORCE_VALUES - static field in class net.dpml.cli.resource.ResourceConstants
Source dest must enforce values error constant.
SourceDestArgument - class net.dpml.cli.option.SourceDestArgument
An Argument implementation that allows a variable size Argument to precede a fixed size argument.
Creates a SourceDestArgument using defaults where possible.
Creates a SourceDestArgument using the specified parameters.
stripBoundaryQuotes(String) - method in class net.dpml.cli.option.ArgumentImpl
If there are any leading or trailing quotes remove them from the specified token.
Switch - class net.dpml.cli.option.Switch
A Parent implementation representing normal switch options.
Creates a new Switch with the specified parameters
SWITCH_ALREADY_SET - static field in class net.dpml.cli.resource.ResourceConstants
Switch already set error constant.
SWITCH_DISABLED_STARTWS_WITH_ENABLED - static field in class net.dpml.cli.resource.ResourceConstants
Switch disabled starts with enabled error constant.
SWITCH_ENABLED_STARTS_WITH_DISABLED - static field in class net.dpml.cli.resource.ResourceConstants
Switch enabled starts with disabled error constant.
SWITCH_IDENTICAL_PREFIXES - static field in class net.dpml.cli.resource.ResourceConstants
Illegal duplicate prefix error constant.
SWITCH_ILLEGAL_DISABLED_PREFIX - static field in class net.dpml.cli.resource.ResourceConstants
Illegal disabled prefix error constant.
SWITCH_ILLEGAL_ENABLED_PREFIX - static field in class net.dpml.cli.resource.ResourceConstants
Preferenced commmand name too long error constant.
SWITCH_NO_DISABLED_PREFIX - static field in class net.dpml.cli.resource.ResourceConstants
No disabled prefix error constant.
SWITCH_NO_ENABLED_PREFIX - static field in class net.dpml.cli.resource.ResourceConstants
No enabled prefix error constant.
SWITCH_PREFERRED_NAME_TOO_SHORT - static field in class net.dpml.cli.resource.ResourceConstants
Switch preferred name too short error constant.
SwitchBuilder - class net.dpml.cli.builder.SwitchBuilder
Builds Switch instance.
SwitchBuilder() - constructor for class net.dpml.cli.builder.SwitchBuilder
Creates a new SwitchBuilder using defaults.
SwitchBuilder(String,String) - constructor for class net.dpml.cli.builder.SwitchBuilder
Creates a new SwitchBuilder
switchFirst() - static method in class net.dpml.cli.util.Comparators
Forces Switch instances to appear at the beginning of lists
switchLast() - static method in class net.dpml.cli.util.Comparators
Forces Switch instances to appear at the end of lists

T

toString() - method in class net.dpml.cli.DisplaySetting
Return a string representation of the instance.
toString() - method in class net.dpml.cli.option.OptionImpl
Returns a string representation of the option.
toString() - method in class net.dpml.cli.commandline.WriteableCommandLineImpl
Return this commandline as a string.

U

UNEXPECTED_TOKEN - static field in class net.dpml.cli.resource.ResourceConstants
Unexpected token error constant.
URIValidator - class net.dpml.cli.validation.URIValidator
The URIValidator validates the string argument values are valid URIs.
URIValidator() - constructor for class net.dpml.cli.validation.URIValidator
Creates a UriValidator.
URIValidator(String) - constructor for class net.dpml.cli.validation.URIValidator
Creates a UriValidator for the specified scheme.
URIValidator(String[]) - constructor for class net.dpml.cli.validation.URIValidator
Creates a UriValidator for the specified schemes.
URIVALIDATOR_MALFORMED_URI - static field in class net.dpml.cli.resource.ResourceConstants
Malformed uri constant.
URLValidator - class net.dpml.cli.validation.URLValidator
The URLValidator validates the string argument values are URLs.
URLValidator() - constructor for class net.dpml.cli.validation.URLValidator
Creates a URLValidator.
URLValidator(String) - constructor for class net.dpml.cli.validation.URLValidator
Creates a URLValidator for the specified protocol.
URLVALIDATOR_MALFORMED_URL - static field in class net.dpml.cli.resource.ResourceConstants
Malformed url constant.
usage(Set,Comparator) - method in class net.dpml.cli.HelpLine
Builds a usage string for the option using the specified settings and comparator.
usage(Set,Comparator) - method in class net.dpml.cli.option.HelpLineImpl
Builds a usage string for the option using the specified settings and comparator.

V

validate(List) - method in class net.dpml.cli.validation.ClassValidator
Validate each argument value in the specified List against this instances permitted attributes.
validate(List) - method in class net.dpml.cli.validation.DateValidator
Validate each String value in the specified List against this instances permitted DateFormats.
validate(List) - method in class net.dpml.cli.validation.EnumValidator
Validate the list of values against the list of permitted values.
validate(List) - method in class net.dpml.cli.validation.FileValidator
Validate the list of values against the list of permitted values.
validate(List) - method in class net.dpml.cli.validation.NumberValidator
Validate the list of values against the list of permitted values.
validate(List) - method in class net.dpml.cli.validation.URIValidator
Validate the list of values against the list of permitted values.
validate(List) - method in class net.dpml.cli.validation.URLValidator
Validate the list of values against the list of permitted values.
validate(List) - method in class net.dpml.cli.validation.Validator
Validate the specified values (List of Strings).
validate(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.ArgumentImpl
Performs any necessary validation on the values added to the CommandLine.
validate(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.Command
Checks that the supplied CommandLine is valid with respect to this option.
validate(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.DefaultOption
Checks that the supplied CommandLine is valid with respect to this option.
validate(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.GroupImpl
Checks that the supplied CommandLine is valid with respect to this option.
Checks that the supplied CommandLine is valid with respect to this option.
validate(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.ParentImpl
Checks that the supplied CommandLine is valid with respect to this option.
validate(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.PropertyOption
Checks that the supplied CommandLine is valid with respect to this option.
validate(net.dpml.cli.WriteableCommandLine) - method in class net.dpml.cli.option.Switch
Checks that the supplied CommandLine is valid with respect to this option.
Performs any necessary validation on the values added to the CommandLine.
Performs any necessary validation on the values added to the CommandLine.
Checks that the supplied CommandLine is valid with respect to the suppled option.
Validator - interface net.dpml.cli.validation.Validator
The validation interface for validating argument values(s).

W

withArgument(net.dpml.cli.Argument) - method in class net.dpml.cli.builder.CommandBuilder
Specifies the argument for the next Command that is created.
withArgument(net.dpml.cli.Argument) - method in class net.dpml.cli.builder.DefaultOptionBuilder
Use this Argument
withArgument(net.dpml.cli.Argument) - method in class net.dpml.cli.builder.SwitchBuilder
Use this Argument
withChildren(net.dpml.cli.Group) - method in class net.dpml.cli.builder.CommandBuilder
Specifies the children for the next Command that is created.
withChildren(net.dpml.cli.Group) - method in class net.dpml.cli.builder.DefaultOptionBuilder
Use this child Group
withChildren(net.dpml.cli.Group) - method in class net.dpml.cli.builder.SwitchBuilder
Use this child Group
withConsumeRemaining(String) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the "consume remaining" option, defaults to "--".
withDefault(Object) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the default value.
withDefaults(List) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the default values.
withDescription(String) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the description of the argument.
withDescription(String) - method in class net.dpml.cli.builder.CommandBuilder
Specifies the description for the next Command that is created.
withDescription(String) - method in class net.dpml.cli.builder.DefaultOptionBuilder
Use this option description
withDescription(String) - method in class net.dpml.cli.builder.GroupBuilder
Use this option description
withDescription(String) - method in class net.dpml.cli.builder.SwitchBuilder
Use this option description
withId(int) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the id
withId(int) - method in class net.dpml.cli.builder.CommandBuilder
Specifies the id for the next Command that is created.
withId(int) - method in class net.dpml.cli.builder.DefaultOptionBuilder
Sets the id
withId(int) - method in class net.dpml.cli.builder.SwitchBuilder
Sets the id
withInitialSeparator(char) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the character used to separate the values from the option.
withLongName(String) - method in class net.dpml.cli.builder.DefaultOptionBuilder
Use this long option name.
withMaximum(int) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the maximum number of values allowed for the argument to be valid.
withMaximum(int) - method in class net.dpml.cli.builder.GroupBuilder
A valid group requires at most this many options present
withMinimum(int) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the minimum number of values needed for the argument to be valid.
withMinimum(int) - method in class net.dpml.cli.builder.GroupBuilder
A valid group requires at least this many options present
withName(String) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the name of the argument.
withName(String) - method in class net.dpml.cli.builder.CommandBuilder
Specifies the name for the next Command that is created.
withName(String) - method in class net.dpml.cli.builder.GroupBuilder
Use this option name
withName(String) - method in class net.dpml.cli.builder.SwitchBuilder
Use this option name.
withOption(net.dpml.cli.Option) - method in class net.dpml.cli.builder.GroupBuilder
Add this option to the group
withPattern(String) - method in class net.dpml.cli.builder.PatternBuilder
Builds an Option using a pattern string.
withRequired(boolean) - method in class net.dpml.cli.builder.CommandBuilder
Specifies whether the next Command created is required or not.
withRequired(boolean) - method in class net.dpml.cli.builder.DefaultOptionBuilder
Use this optionality
withRequired(boolean) - method in class net.dpml.cli.builder.SwitchBuilder
Use this optionality
withShortName(String) - method in class net.dpml.cli.builder.DefaultOptionBuilder
Use this short option name.
withSubsequentSeparator(char) - method in class net.dpml.cli.builder.ArgumentBuilder
Sets the character used to separate the values from each other.
withSwitchDefault(Boolean) - method in class net.dpml.cli.builder.SwitchBuilder
Sets the default state for this switch
Sets the validator instance used to perform validation on the Argument values.
wrap(String,int) - static method in class net.dpml.cli.util.HelpFormatter
Return a list of strings resulting from the wrapping of a supplied target string.
A CommandLine that detected values and options can be written to.
WriteableCommandLineImpl - class net.dpml.cli.commandline.WriteableCommandLineImpl
A WriteableCommandLine implementation allowing Options to write their processed information to a CommandLine.
WriteableCommandLineImpl(net.dpml.cli.Option,List) - constructor for class net.dpml.cli.commandline.WriteableCommandLineImpl
Creates a new WriteableCommandLineImpl rooted on the specified Option, to hold the parsed arguments.