- DateValidator - Class in net.dpml.cli.validation
-
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 variable in class net.dpml.cli.resource.ResourceConstants
-
Date out of range constant.
- DEFAULT_BURST_ENABLED - Static variable in class net.dpml.cli.option.DefaultOption
-
The default value for the burstEnabled constructor parameter
- DEFAULT_CONSUME_REMAINING - Static variable in class net.dpml.cli.option.ArgumentImpl
-
The default token to indicate that remaining arguments should be consumed
as values.
- DEFAULT_DESCRIPTION - Static variable in class net.dpml.cli.option.PropertyOption
-
The default property option description.
- DEFAULT_DESCRIPTION_WIDTH - Static variable in class net.dpml.cli.util.HelpFormatter
-
The default minimum description width.
- DEFAULT_DISABLED_PREFIX - Static variable in class net.dpml.cli.option.Switch
-
The default prefix for disabled switches
- DEFAULT_DISPLAY_USAGE_SETTINGS - Static variable 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 variable in class net.dpml.cli.option.Switch
-
The default prefix for enabled switches
- DEFAULT_FULL_USAGE_SETTINGS - Static variable 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 variable in class net.dpml.cli.util.HelpFormatter
-
The default screen width
- DEFAULT_GUTTER_CENTER - Static variable in class net.dpml.cli.util.HelpFormatter
-
The default screen furniture right of screen
- DEFAULT_GUTTER_LEFT - Static variable in class net.dpml.cli.util.HelpFormatter
-
The default screen furniture left of screen
- DEFAULT_GUTTER_RIGHT - Static variable in class net.dpml.cli.util.HelpFormatter
-
The default screen furniture between columns
- DEFAULT_INITIAL_SEPARATOR - Static variable in class net.dpml.cli.option.ArgumentImpl
-
The default value for the initial separator char.
- DEFAULT_LINE_USAGE_SETTINGS - Static variable 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 variable in class net.dpml.cli.option.DefaultOption
-
The default token used to prefix a long option
- DEFAULT_OPTION_STRING - Static variable in class net.dpml.cli.option.PropertyOption
-
The default property option name.
- DEFAULT_SHORT_PREFIX - Static variable in class net.dpml.cli.option.DefaultOption
-
The default token used to prefix a short option
- DEFAULT_SUBSEQUENT_SEPARATOR - Static variable in class net.dpml.cli.option.ArgumentImpl
-
The default value for the subsequent separator char.
- DefaultingCommandLine - Class in net.dpml.cli.commandline
-
Manages a queue of default CommandLines.
- DefaultingCommandLine() - Constructor for class net.dpml.cli.commandline.DefaultingCommandLine
-
- DefaultOption - Class in net.dpml.cli.option
-
A Parent implementation representing normal options.
- DefaultOption(String, String, boolean, String, String, Set, Set, boolean, Argument, Group, int) - Constructor for class net.dpml.cli.option.DefaultOption
-
Creates a new DefaultOption
- DefaultOptionBuilder - Class in net.dpml.cli.builder
-
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(WriteableCommandLine) - Method in class net.dpml.cli.option.ArgumentImpl
-
Adds defaults to a CommandLine.
- defaults(WriteableCommandLine) - Method in interface net.dpml.cli.Option
-
Adds defaults to a CommandLine.
- defaults(WriteableCommandLine) - Method in class net.dpml.cli.option.GroupImpl
-
Process defaults.
- defaults(WriteableCommandLine) - Method in class net.dpml.cli.option.OptionImpl
-
Adds defaults to a CommandLine.
- defaults(WriteableCommandLine) - Method in class net.dpml.cli.option.ParentImpl
-
Adds defaults to a CommandLine.
- defaults(WriteableCommandLine) - Method in class net.dpml.cli.option.Switch
-
Adds defaults to a CommandLine.
- defaultValues(WriteableCommandLine, Option) - Method in interface net.dpml.cli.Argument
-
Adds defaults to a CommandLine.
- defaultValues(WriteableCommandLine, Option) - Method in class net.dpml.cli.option.ArgumentImpl
-
Adds defaults to a CommandLine.
- DISPLAY_ALIASES - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that aliases should be included
- DISPLAY_ARGUMENT_BRACKETED - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that arguments should be included bracketed
- DISPLAY_ARGUMENT_NUMBERED - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that arguments should be included numbered
- DISPLAY_GROUP_ARGUMENT - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that group arguments should be included
- DISPLAY_GROUP_EXPANDED - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that groups should be included expanded
- DISPLAY_GROUP_NAME - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that group names should be included
- DISPLAY_GROUP_OUTER - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that group outer brackets should be included
- DISPLAY_OPTIONAL - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that optionality should be included
- DISPLAY_PARENT_ARGUMENT - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that arguments of Parents should be included
- DISPLAY_PARENT_CHILDREN - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that children of Parents should be included
- DISPLAY_PROPERTY_OPTION - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that property options should be included
- DISPLAY_SWITCH_DISABLED - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that switches should be included disabled
- DISPLAY_SWITCH_ENABLED - Static variable in class net.dpml.cli.DisplaySetting
-
Indicates that switches should be included enabled
- DisplaySetting - Class in net.dpml.cli
-
An enum of possible display settings.
- 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 interface net.dpml.cli.HelpLine
-
- getDescription() - Method in class net.dpml.cli.option.ArgumentImpl
-
Returns a description of the option.
- getDescription() - Method in interface net.dpml.cli.Option
-
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.option.HelpLineImpl
-
- 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 interface 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 interface net.dpml.cli.HelpLine
-
- getIndent() - Method in class net.dpml.cli.option.HelpLineImpl
-
- getInitialSeparator() - Method in interface 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 interface net.dpml.cli.Argument
-
Retrieves the maximum number of values acceptable for a valid Argument
- getMaximum() - Method in interface net.dpml.cli.Group
-
Retrieves the maximum number of members acceptable for a valid Group
- 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.option.GroupImpl
-
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.validation.NumberValidator
-
Return the maximum value allowed for an argument value.
- getMessage() - Method in exception 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 interface net.dpml.cli.Argument
-
Retrieves the minimum number of values required for a valid Argument
- getMinimum() - Method in interface net.dpml.cli.Group
-
Retrieves the minimum number of members required for a valid Group
- 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.option.GroupImpl
-
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.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(String) - Method in class net.dpml.cli.commandline.DefaultingCommandLine
-
Finds the Option with the specified trigger
- getOption(String) - Method in interface net.dpml.cli.CommandLine
-
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
- getOption() - Method in interface net.dpml.cli.HelpLine
-
- getOption() - Method in class net.dpml.cli.option.HelpLineImpl
-
- getOption() - Method in exception net.dpml.cli.OptionException
-
Gets the Option the exception relates to
- getOptionCount(String) - Method in class net.dpml.cli.commandline.CommandLineImpl
-
Retrieves the number of times the specified Option appeared in this
CommandLine
- getOptionCount(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 interface net.dpml.cli.CommandLine
-
Retrieves the number of times the specified Option appeared in this
CommandLine
- getOptionCount(Option) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the number of times the specified Option appeared 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 interface net.dpml.cli.CommandLine
-
Retrieves a list of all Options found in this CommandLine
- 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
- getOptions() - Method in class net.dpml.cli.option.GroupImpl
-
Gets the member Options of thie Group.
- getOptionTriggers() - Method in class net.dpml.cli.commandline.DefaultingCommandLine
-
Retrieves a list of all Option triggers found in this CommandLine
- getOptionTriggers() - Method in interface net.dpml.cli.CommandLine
-
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 interface 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.GroupImpl
-
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 interface net.dpml.cli.Option
-
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.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.DefaultingCommandLine
-
Retrieves the set of all property names associated with this CommandLine
- getProperties() - Method in interface net.dpml.cli.CommandLine
-
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.CommandLineImpl
-
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) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the value associated with the specified property
- getProperty(String, String) - Method in interface net.dpml.cli.CommandLine
-
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(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.CommandLineImpl
-
Retrieves the Boolean value associated with the specified Switch
- getSwitch(Option) - Method in class net.dpml.cli.commandline.CommandLineImpl
-
Retrieves the Boolean value associated with the specified Switch
- getSwitch(Option, Boolean) - Method in class net.dpml.cli.commandline.DefaultingCommandLine
-
Retrieves the Boolean value associated with the specified Switch
- getSwitch(String) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the Boolean value associated with the specified Switch
- getSwitch(String, Boolean) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the Boolean value associated with the specified Switch
- getSwitch(Option) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the Boolean value associated with the specified Switch
- getSwitch(Option, Boolean) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the Boolean value associated with the specified Switch
- getSwitch(Option, Boolean) - Method in class net.dpml.cli.commandline.PreferencesCommandLine
-
Retrieves the Boolean value associated with the specified Switch
- getSwitch(Option, Boolean) - Method in class net.dpml.cli.commandline.PropertiesCommandLine
-
Retrieves the Boolean value associated with the specified Switch
- getSwitch(Option, Boolean) - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl
-
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 interface net.dpml.cli.Option
-
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.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(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.CommandLineImpl
-
Retrieves the single Argument value associated with the specified Option
- getValue(Option) - Method in class net.dpml.cli.commandline.CommandLineImpl
-
Retrieves the single Argument value associated with the specified Option
- getValue(Option, Object) - Method in class net.dpml.cli.commandline.CommandLineImpl
-
Retrieves the single Argument value associated with the specified Option
- getValue(String) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the single Argument value associated with the specified Option
- getValue(String, Object) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the single Argument value associated with the specified Option
- getValue(Option) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the single Argument value associated with the specified Option
- getValue(Option, Object) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the single Argument value 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.CommandLineImpl
-
Retrieves the Argument values associated with the specified Option
- getValues(Option) - Method in class net.dpml.cli.commandline.CommandLineImpl
-
Retrieves the Argument values associated with the specified Option
- getValues(Option, List) - Method in class net.dpml.cli.commandline.DefaultingCommandLine
-
Retrieves the Argument values associated with the specified Option
- getValues(String) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the Argument values associated with the specified Option
- getValues(String, List) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the Argument values associated with the specified Option
- getValues(Option) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the Argument values associated with the specified Option
- getValues(Option, List) - Method in interface net.dpml.cli.CommandLine
-
Retrieves the Argument values associated with the specified Option
- getValues(Option, List) - Method in class net.dpml.cli.commandline.PreferencesCommandLine
-
Retrieves the Argument values associated with the specified Option
- getValues(Option, List) - Method in class net.dpml.cli.commandline.PropertiesCommandLine
-
Retrieves the Argument values associated with the specified Option
- getValues(Option, List) - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl
-
Retrieves the Argument values associated with the specified Option
- Group - Interface in net.dpml.cli
-
An Option representing a choice or group of Options in the form "-a|-b|-c".
- GroupBuilder - Class in net.dpml.cli.builder
-
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 in net.dpml.cli.option
-
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
- pad(String, int, Writer) - Static method in class net.dpml.cli.util.HelpFormatter
-
Pad the supplied string.
- Parent - Interface in net.dpml.cli
-
An Option that can have an argument and/or group of child Options in the form
"-f <arg> [-a|-b|-c]".
- ParentImpl - Class in net.dpml.cli.option
-
A base implementation of Parent providing limited ground work for further
Parent implementations.
- ParentImpl(Argument, Group, String, int, boolean) - Constructor for class net.dpml.cli.option.ParentImpl
-
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 in net.dpml.cli.commandline
-
A class that implements the
Parser interface can parse a
String array according to the
Groupspecified and return a
CommandLine.
- Parser() - Constructor for class net.dpml.cli.commandline.Parser
-
- PatternBuilder - Class in net.dpml.cli.builder
-
Builds Options using a String pattern
- PatternBuilder() - Constructor for class net.dpml.cli.builder.PatternBuilder
-
Creates a new PatternBuilder
- PatternBuilder(GroupBuilder, DefaultOptionBuilder, ArgumentBuilder) - Constructor for class net.dpml.cli.builder.PatternBuilder
-
Creates a new PatternBuilder
- PreferencesCommandLine - Class in net.dpml.cli.commandline
-
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.
- PreferencesCommandLine(Option, Preferences) - Constructor for class net.dpml.cli.commandline.PreferencesCommandLine
-
Creates a new PreferencesCommandLine using the specified root Option and
Preferences node.
- PreferencesCommandLine(Option, Preferences, char) - Constructor for class net.dpml.cli.commandline.PreferencesCommandLine
-
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
- process(WriteableCommandLine, ListIterator) - Method in class net.dpml.cli.option.ArgumentImpl
-
Processes String arguments into a CommandLine.
- process(WriteableCommandLine, ListIterator) - Method in class net.dpml.cli.option.GroupImpl
-
Processes String arguments into a CommandLine.
- process(WriteableCommandLine, ListIterator) - Method in class net.dpml.cli.option.ParentImpl
-
Processes String arguments into a CommandLine.
- process(WriteableCommandLine, ListIterator) - Method in interface net.dpml.cli.Option
-
Processes String arguments into a CommandLine.
- process(WriteableCommandLine, ListIterator) - Method in class net.dpml.cli.option.PropertyOption
-
Processes String arguments into a CommandLine.
- processParent(WriteableCommandLine, ListIterator) - Method in class net.dpml.cli.option.Command
-
Process the parent.
- processParent(WriteableCommandLine, ListIterator) - Method in class net.dpml.cli.option.DefaultOption
-
Process the parent.
- processParent(WriteableCommandLine, ListIterator) - Method in class net.dpml.cli.option.Switch
-
Processes the parent part of the Option.
- processParent(WriteableCommandLine, ListIterator) - Method in interface net.dpml.cli.Parent
-
Processes the parent part of the Option.
- processValues(WriteableCommandLine, ListIterator, Option) - Method in interface net.dpml.cli.Argument
-
Processes the "README" style element of the argument.
- processValues(WriteableCommandLine, ListIterator, Option) - Method in class net.dpml.cli.option.ArgumentImpl
-
Processes the "README" style element of the argument.
- PropertiesCommandLine - Class in net.dpml.cli.commandline
-
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(Option, Properties) - Constructor for class net.dpml.cli.commandline.PropertiesCommandLine
-
Creates a new PropertiesCommandLine using the specified root Option,
Properties instance.
- PropertiesCommandLine(Option, Properties, char) - Constructor for class net.dpml.cli.commandline.PropertiesCommandLine
-
Creates a new PropertiesCommandLine using the specified root Option,
Properties instance and value separator.
- PropertyOption - Class in net.dpml.cli.option
-
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
- 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
- setDefaultSwitch(Option, Boolean) - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl
-
Set default switch.
- setDefaultSwitch(Option, Boolean) - Method in interface net.dpml.cli.WriteableCommandLine
-
Sets the default state for a Switch in the CommandLine.
- setDefaultValues(Option, List) - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl
-
Set default values.
- setDefaultValues(Option, List) - Method in interface net.dpml.cli.WriteableCommandLine
-
Sets the default values for an Option in the CommandLine
- 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(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(List) - Method in class net.dpml.cli.validation.DateValidator
-
Sets the date formats permitted.
- setFormats(DateFormat[]) - 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(Group) - Method in class net.dpml.cli.commandline.Parser
-
Sets the Group of options to parse against
- setGroup(Group) - Method in class net.dpml.cli.util.HelpFormatter
-
Sets the Group of Options to document
- setHeader(String) - Method in class net.dpml.cli.util.HelpFormatter
-
Sets the header text of the help screen
- setHelpFormatter(HelpFormatter) - Method in class net.dpml.cli.commandline.Parser
-
Sets the HelpFormatter to use with the simplified parsing.
- setHelpOption(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 variable in class net.dpml.cli.resource.ResourceConstants
-
Source dest must enforce values error constant.
- SourceDestArgument - Class in net.dpml.cli.option
-
An Argument implementation that allows a variable size Argument to precede a
fixed size argument.
- SourceDestArgument(Argument, Argument) - Constructor for class net.dpml.cli.option.SourceDestArgument
-
Creates a SourceDestArgument using defaults where possible.
- SourceDestArgument(Argument, Argument, char, char, String, List) - Constructor for class net.dpml.cli.option.SourceDestArgument
-
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 in net.dpml.cli.option
-
A Parent implementation representing normal switch options.
- Switch(String, String, String, Set, String, boolean, Argument, Group, int, Boolean) - Constructor for class net.dpml.cli.option.Switch
-
Creates a new Switch with the specified parameters
- SWITCH_ALREADY_SET - Static variable in class net.dpml.cli.resource.ResourceConstants
-
Switch already set error constant.
- SWITCH_DISABLED_STARTWS_WITH_ENABLED - Static variable in class net.dpml.cli.resource.ResourceConstants
-
Switch disabled starts with enabled error constant.
- SWITCH_ENABLED_STARTS_WITH_DISABLED - Static variable in class net.dpml.cli.resource.ResourceConstants
-
Switch enabled starts with disabled error constant.
- SWITCH_IDENTICAL_PREFIXES - Static variable in class net.dpml.cli.resource.ResourceConstants
-
Illegal duplicate prefix error constant.
- SWITCH_ILLEGAL_DISABLED_PREFIX - Static variable in class net.dpml.cli.resource.ResourceConstants
-
Illegal disabled prefix error constant.
- SWITCH_ILLEGAL_ENABLED_PREFIX - Static variable in class net.dpml.cli.resource.ResourceConstants
-
Preferenced commmand name too long error constant.
- SWITCH_NO_DISABLED_PREFIX - Static variable in class net.dpml.cli.resource.ResourceConstants
-
No disabled prefix error constant.
- SWITCH_NO_ENABLED_PREFIX - Static variable in class net.dpml.cli.resource.ResourceConstants
-
No enabled prefix error constant.
- SWITCH_PREFERRED_NAME_TOO_SHORT - Static variable in class net.dpml.cli.resource.ResourceConstants
-
Switch preferred name too short error constant.
- SwitchBuilder - Class in net.dpml.cli.builder
-
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