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

A

addOption(Option) - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl

Add an option.

addOption(Option) - Method in interface net.dpml.cli.WriteableCommandLine

Adds an Option to the CommandLine

addProperty(String, String) - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl

Add a property to the commandline.

addProperty(String, String) - Method in interface net.dpml.cli.WriteableCommandLine

Adds a property value to a name in the CommandLine.

addSwitch(Option, boolean) - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl

Add a switch.

addSwitch(Option, boolean) - Method in interface net.dpml.cli.WriteableCommandLine

Adds a switch value to an Option in the CommandLine.

addValue(Option, Object) - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl

Add an option.

addValue(Option, Object) - Method in interface net.dpml.cli.WriteableCommandLine

Adds a value to an Option in the CommandLine.

ALL - Static variable in class net.dpml.cli.DisplaySetting

A Set guarenteed to contain all possible DisplaySetting values

appendCommandLine(CommandLine) - Method in class net.dpml.cli.commandline.DefaultingCommandLine

Adds a CommandLine instance to the back of the queue.

appendUsage(StringBuffer, Set, Comparator, String) - Method in interface net.dpml.cli.Group

Appends usage information to the specified StringBuffer

appendUsage(StringBuffer, Set, Comparator) - Method in interface net.dpml.cli.Option

Appends usage information to the specified StringBuffer

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, String) - 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.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

Argument - Interface in net.dpml.cli

An Option that can process values passed on the command line in the form "--file README".

ARGUMENT_BUILDER_EMPTY_CONSUME_REMAINING - Static variable in class net.dpml.cli.resource.ResourceConstants

Empty consume remaining error constant.

ARGUMENT_BUILDER_EMPTY_NAME - Static variable in class net.dpml.cli.resource.ResourceConstants

Empty name error constant.

ARGUMENT_BUILDER_NEGATIVE_MAXIMUM - Static variable in class net.dpml.cli.resource.ResourceConstants

Negative maximum error constant.

ARGUMENT_BUILDER_NEGATIVE_MINIMUM - Static variable in class net.dpml.cli.resource.ResourceConstants

Negative minimum error constant.

ARGUMENT_BUILDER_NULL_CONSUME_REMAINING - Static variable in class net.dpml.cli.resource.ResourceConstants

Null consume remaining error constant.

ARGUMENT_BUILDER_NULL_DEFAULT - Static variable in class net.dpml.cli.resource.ResourceConstants

Null default error constant.

ARGUMENT_BUILDER_NULL_DEFAULTS - Static variable in class net.dpml.cli.resource.ResourceConstants

Null defaults error constant.

ARGUMENT_BUILDER_NULL_NAME - Static variable in class net.dpml.cli.resource.ResourceConstants

Null name error constant.

ARGUMENT_BUILDER_NULL_VALIDATOR - Static variable in class net.dpml.cli.resource.ResourceConstants

Null validator argument error constant.

ARGUMENT_MIN_EXCEEDS_MAX - Static variable in class net.dpml.cli.resource.ResourceConstants

Minimum greater than maximum error constant.

ARGUMENT_MISSING_VALUES - Static variable in class net.dpml.cli.resource.ResourceConstants

Missing argument error constant.

ARGUMENT_TOO_FEW_DEFAULTS - Static variable in class net.dpml.cli.resource.ResourceConstants

Too few defaults error constant.

ARGUMENT_TOO_MANY_DEFAULTS - Static variable in class net.dpml.cli.resource.ResourceConstants

Too many defaults error constant.

ARGUMENT_TOO_MANY_VALUES - Static variable in class net.dpml.cli.resource.ResourceConstants

Too many argument values error constant.

ARGUMENT_UNEXPECTED_VALUE - Static variable in class net.dpml.cli.resource.ResourceConstants

Unexpected argument value constant.

ArgumentBuilder - Class in net.dpml.cli.builder

Builds Argument instances.

ArgumentBuilder() - Constructor for class net.dpml.cli.builder.ArgumentBuilder

Creates a new ArgumentBuilder instance

ArgumentImpl - Class in net.dpml.cli.option

An implementation of an Argument.

ArgumentImpl(String, String, int, int, char, char, Validator, String, List, int) - Constructor for class net.dpml.cli.option.ArgumentImpl

Creates a new Argument instance.

C

CANNOT_BURST - Static variable in class net.dpml.cli.resource.ResourceConstants

Cannot burst error constant.

canProcess(WriteableCommandLine, String) - Method in class net.dpml.cli.option.ArgumentImpl

Indicates whether this Option will be able to process the particular argument.

canProcess(WriteableCommandLine, String) - Method in interface net.dpml.cli.Option

Indicates whether this Option will be able to process the particular argument.

canProcess(WriteableCommandLine, ListIterator) - Method in interface net.dpml.cli.Option

Indicates whether this Option will be able to process the particular argument.

canProcess(WriteableCommandLine, String) - Method in class net.dpml.cli.option.DefaultOption

Indicates whether this Option will be able to process the particular argument.

canProcess(WriteableCommandLine, String) - Method in class net.dpml.cli.option.GroupImpl

Indicates whether this Option will be able to process the particular argument.

canProcess(WriteableCommandLine, ListIterator) - Method in class net.dpml.cli.option.OptionImpl

Indicates whether this Option will be able to process the particular argument.

canProcess(WriteableCommandLine, String) - Method in class net.dpml.cli.option.ParentImpl

Indicates whether this Option will be able to process the particular argument.

canProcess(WriteableCommandLine, String) - Method in class net.dpml.cli.option.PropertyOption

Indicates whether this Option will be able to process the particular argument.

canProcess(WriteableCommandLine, String) - Method in class net.dpml.cli.option.SourceDestArgument

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.

chain(Comparator, Comparator, Comparator, Comparator, Comparator) - Static method in class net.dpml.cli.util.Comparators

Chains comparators together.

chain(List) - Static method in class net.dpml.cli.util.Comparators

Chains comparators together.

chain(Comparator[]) - Static method in class net.dpml.cli.util.Comparators

Chains an array of comparators together.

checkPrefixes(Set) - Method in class net.dpml.cli.option.OptionImpl

Check prefixes.

ClassValidator - Class in net.dpml.cli.validation

The ClassValidator validates the string argument values are class names.

ClassValidator() - Constructor for class net.dpml.cli.validation.ClassValidator

CLASSVALIDATOR_BAD_CLASSNAME - Static variable in class net.dpml.cli.resource.ResourceConstants

Bad classname constant.

CLASSVALIDATOR_CLASS_ACCESS - Static variable in class net.dpml.cli.resource.ResourceConstants

Class access constant.

CLASSVALIDATOR_CLASS_CREATE - Static variable in class net.dpml.cli.resource.ResourceConstants

Class creation constant.

CLASSVALIDATOR_CLASS_NOTFOUND - Static variable in class net.dpml.cli.resource.ResourceConstants

Class not found constant.

Command - Class in net.dpml.cli.option

Represents a cvs "update" style command line option.

Command(String, String, Set, boolean, Argument, Group, int) - Constructor for class net.dpml.cli.option.Command

Creates a new Command instance.

COMMAND_PREFERRED_NAME_TOO_SHORT - Static variable in class net.dpml.cli.resource.ResourceConstants

Preferenced commmand name too long error constant.

CommandBuilder - Class in net.dpml.cli.builder

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 in net.dpml.cli

Instances of CommandLine represent a command line that has been processed according to the definition supplied to the parser.

CommandLineImpl - Class in net.dpml.cli.commandline

Instances of CommandLine represent a command line that has been processed according to the definition supplied to the parser.

CommandLineImpl() - Constructor for class net.dpml.cli.commandline.CommandLineImpl

commandLines() - Method in class net.dpml.cli.commandline.DefaultingCommandLine

Builds an iterator over the build in CommandLines.

Comparators - Class in net.dpml.cli.util

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

E

ENUM_ILLEGAL_VALUE - Static variable in class net.dpml.cli.resource.ResourceConstants

Illegal emumeration value error constant.

EnumValidator - Class in net.dpml.cli.validation

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 in net.dpml.cli.validation

The FileValidator validates the string argument values are files.

FileValidator() - Constructor for class net.dpml.cli.validation.FileValidator

findOption(String) - Method in interface net.dpml.cli.Option

Recursively searches for an option with the supplied trigger.

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

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(String) - Method in class net.dpml.cli.commandline.CommandLineImpl

Detects the presence of an option with the specified trigger in this CommandLine.

hasOption(Option) - Method in class net.dpml.cli.commandline.DefaultingCommandLine

Detects the presence of an option in this CommandLine.

hasOption(String) - Method in interface net.dpml.cli.CommandLine

Detects the presence of an option with the specified trigger in this CommandLine.

hasOption(Option) - Method in interface net.dpml.cli.CommandLine

Detects the presence of an option in this CommandLine.

hasOption(Option) - Method in class net.dpml.cli.commandline.PreferencesCommandLine

Detects the presence of an option in this CommandLine.

hasOption(Option) - Method in class net.dpml.cli.commandline.PropertiesCommandLine

Detects the presence of an option in this CommandLine.

hasOption(Option) - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl

Detects the presence of an option in this CommandLine.

HELP_SETTINGS - Static variable in exception net.dpml.cli.OptionException

The settings used when displaying the related Option.

HelpFormatter - Class in net.dpml.cli.util

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 variable in class net.dpml.cli.resource.ResourceConstants

Gutter too long error constant.

HELPFORMATTER_WIDTH_TOO_NARROW - Static variable in class net.dpml.cli.resource.ResourceConstants

Width too narrow error constant.

HelpLine - Interface in net.dpml.cli

Represents a line of help for a particular Option.

HelpLineImpl - Class in net.dpml.cli.option

Represents a line in the help screen.

HelpLineImpl(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 interface 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

insertCommandLine(int, CommandLine) - Method in class net.dpml.cli.commandline.DefaultingCommandLine

Adds a CommandLine instance to a specified position in the queue.

INSTANCE - Static variable in class net.dpml.cli.option.PropertyOption

A default PropertyOption instance

InvalidArgumentException - Exception in net.dpml.cli.validation

An exception indicating validation failure.

InvalidArgumentException(String) - Constructor for exception 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 interface net.dpml.cli.Argument

Indicates whether argument values must be present for the CommandLine to be valid.

isRequired() - Method in interface 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.ArgumentImpl

Indicates whether argument values 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 interface 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.commandline.WriteableCommandLineImpl

Return true if the trigger argument looks like an option.

looksLikeOption(String) - Method in interface net.dpml.cli.WriteableCommandLine

Detects whether the argument looks like an Option trigger

M

MISSING_OPTION - Static variable 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 net.dpml.cli

Commandline modeling and parsing utilities.

net.dpml.cli.builder - package net.dpml.cli.builder

Helpers supporting the construction of a commandline model.

net.dpml.cli.commandline - package net.dpml.cli.commandline

Commandline implementation.

net.dpml.cli.option - package net.dpml.cli.option

Options implementation include command, group, switch and property abstractions.

net.dpml.cli.resource - package net.dpml.cli.resource

Internationalization resources.

net.dpml.cli.util - package net.dpml.cli.util

Commandline utilities including help formatter.

net.dpml.cli.validation - package net.dpml.cli.validation

Provides classes and interfaces for validating argument values.

NONE - Static variable in class net.dpml.cli.DisplaySetting

A Set guarenteed to contain no DisplaySetting values

NumberValidator - Class in net.dpml.cli.validation

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 variable in class net.dpml.cli.resource.ResourceConstants

Number out-of-range constant.

O

Option - Interface in net.dpml.cli

The super type of all options representing a particular element of the command line interface.

OPTION_ILLEGAL_LONG_PREFIX - Static variable in class net.dpml.cli.resource.ResourceConstants

Illegal long prefix error constant.

OPTION_ILLEGAL_SHORT_PREFIX - Static variable in class net.dpml.cli.resource.ResourceConstants

Illegal short prefix error constant.

OPTION_MISSING_REQUIRED - Static variable in class net.dpml.cli.resource.ResourceConstants

Missing required option error constant.

OPTION_NO_NAME - Static variable in class net.dpml.cli.resource.ResourceConstants

Missing option name error constant.

OPTION_TRIGGER_NEEDS_PREFIX - Static variable in class net.dpml.cli.resource.ResourceConstants

Missing trigger prefix error constant.

OptionException - Exception in net.dpml.cli

A problem found while dealing with command line options.

OptionException(Option) - Constructor for exception net.dpml.cli.OptionException

Creates a new OptionException.

OptionException(Option, String) - Constructor for exception net.dpml.cli.OptionException

Creates a new OptionException.

OptionException(Option, String, String) - Constructor for exception net.dpml.cli.OptionException

Creates a new OptionException.

OptionImpl - Class in net.dpml.cli.option

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 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

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 in net.dpml.cli.resource

Common resurce constants.

ResourceConstants() - Constructor for class net.dpml.cli.resource.ResourceConstants

ResourceHelper - Class in net.dpml.cli.resource

A utility class used to provide internationalisation support.

RESOURCES - Static variable 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

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

T

toString() - Method in class net.dpml.cli.commandline.WriteableCommandLineImpl

Return this commandline as a string.

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.

U

UNEXPECTED_TOKEN - Static variable in class net.dpml.cli.resource.ResourceConstants

Unexpected token error constant.

URIValidator - Class in net.dpml.cli.validation

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 variable in class net.dpml.cli.resource.ResourceConstants

Malformed uri constant.

URLValidator - Class in net.dpml.cli.validation

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 variable in class net.dpml.cli.resource.ResourceConstants

Malformed url constant.

usage(Set, Comparator) - Method in interface 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(WriteableCommandLine, Option) - Method in interface net.dpml.cli.Argument

Performs any necessary validation on the values added to the CommandLine.

validate(WriteableCommandLine) - Method in class net.dpml.cli.option.ArgumentImpl

Performs any necessary validation on the values added to the CommandLine.

validate(WriteableCommandLine, Option) - Method in class net.dpml.cli.option.ArgumentImpl

Performs any necessary validation on the values added to the CommandLine.

validate(WriteableCommandLine) - Method in class net.dpml.cli.option.Command

Checks that the supplied CommandLine is valid with respect to this option.

validate(WriteableCommandLine) - Method in class net.dpml.cli.option.DefaultOption

Checks that the supplied CommandLine is valid with respect to this option.

validate(WriteableCommandLine) - Method in class net.dpml.cli.option.GroupImpl

Checks that the supplied CommandLine is valid with respect to this option.

validate(WriteableCommandLine) - Method in class net.dpml.cli.option.ParentImpl

Checks that the supplied CommandLine is valid with respect to this option.

validate(WriteableCommandLine) - Method in class net.dpml.cli.option.PropertyOption

Checks that the supplied CommandLine is valid with respect to this option.

validate(WriteableCommandLine, Option) - Method in class net.dpml.cli.option.SourceDestArgument

Checks that the supplied CommandLine is valid with respect to the suppled option.

validate(WriteableCommandLine) - Method in class net.dpml.cli.option.Switch

Checks that the supplied CommandLine is valid with respect to this option.

validate(WriteableCommandLine) - Method in interface net.dpml.cli.Option

Checks that the supplied CommandLine is valid with respect to this option.

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 interface net.dpml.cli.validation.Validator

Validate the specified values (List of Strings).

Validator - Interface in net.dpml.cli.validation

The validation interface for validating argument values(s).

W

withArgument(Argument) - Method in class net.dpml.cli.builder.CommandBuilder

Specifies the argument for the next Command that is created.

withArgument(Argument) - Method in class net.dpml.cli.builder.DefaultOptionBuilder

Use this Argument

withArgument(Argument) - Method in class net.dpml.cli.builder.SwitchBuilder

Use this Argument

withChildren(Group) - Method in class net.dpml.cli.builder.CommandBuilder

Specifies the children for the next Command that is created.

withChildren(Group) - Method in class net.dpml.cli.builder.DefaultOptionBuilder

Use this child Group

withChildren(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(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

withValidator(Validator) - Method in class net.dpml.cli.builder.ArgumentBuilder

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.

WriteableCommandLine - Interface in net.dpml.cli

A CommandLine that detected values and options can be written to.

WriteableCommandLineImpl - Class in net.dpml.cli.commandline

A WriteableCommandLine implementation allowing Options to write their processed information to a CommandLine.

WriteableCommandLineImpl(Option, List) - Constructor for class net.dpml.cli.commandline.WriteableCommandLineImpl

Creates a new WriteableCommandLineImpl rooted on the specified Option, to hold the parsed arguments.

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