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

A

abuilder - Variable in class org.apache.commons.cli2.builder.PatternBuilder
 
addOption(Option) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
addOption(Option) - Method in interface org.apache.commons.cli2.WriteableCommandLine
Adds an Option to the CommandLine
addProperty(String, String) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
addProperty(String, String) - Method in interface org.apache.commons.cli2.WriteableCommandLine
Adds a property value to a name in the CommandLine.
addSwitch(Option, boolean) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
addSwitch(Option, boolean) - Method in interface org.apache.commons.cli2.WriteableCommandLine
Adds a switch value to an Option in the CommandLine.
addValue(Option, Object) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
addValue(Option, Object) - Method in interface org.apache.commons.cli2.WriteableCommandLine
Adds a value to an Option in the CommandLine.
aliases - Variable in class org.apache.commons.cli2.builder.CommandBuilder
the aliases of the command
aliases - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
aliases - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
aliases - Variable in class org.apache.commons.cli2.option.Command
The aliases for this command
aliases - Variable in class org.apache.commons.cli2.option.DefaultOption
 
aliases - Variable in class org.apache.commons.cli2.option.Switch
 
all - Static variable in class org.apache.commons.cli2.DisplaySetting
 
ALL - Static variable in class org.apache.commons.cli2.DisplaySetting
A Set guarenteed to contain all possible DisplaySetting values
anonymous - Variable in class org.apache.commons.cli2.option.GroupImpl
 
appendCommandLine(CommandLine) - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
Adds a CommandLine instance to the back of the queue.
appendUsage(StringBuffer, Set, Comparator, String) - Method in interface org.apache.commons.cli2.Group
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer, Set, Comparator) - Method in interface org.apache.commons.cli2.Option
Appends usage information to the specified StringBuffer
appendUsage(StringBuffer, Set, Comparator) - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
appendUsage(StringBuffer, Set, Comparator) - Method in class org.apache.commons.cli2.option.Command
 
appendUsage(StringBuffer, Set, Comparator) - Method in class org.apache.commons.cli2.option.DefaultOption
 
appendUsage(StringBuffer, Set, Comparator) - Method in class org.apache.commons.cli2.option.GroupImpl
 
appendUsage(StringBuffer, Set, Comparator, String) - Method in class org.apache.commons.cli2.option.GroupImpl
 
appendUsage(StringBuffer, Set, Comparator) - Method in class org.apache.commons.cli2.option.ParentImpl
 
appendUsage(StringBuffer, Set, Comparator) - Method in class org.apache.commons.cli2.option.PropertyOption
 
appendUsage(StringBuffer, Set, Comparator) - Method in class org.apache.commons.cli2.option.SourceDestArgument
 
appendUsage(StringBuffer, Set, Comparator) - Method in class org.apache.commons.cli2.option.Switch
 
Argument - Interface in org.apache.commons.cli2
An Option that can process values passed on the command line in the form "--file README".
argument - Variable in class org.apache.commons.cli2.builder.CommandBuilder
the argument of the command
argument - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
argument - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
argument - Variable in class org.apache.commons.cli2.option.ParentImpl
 
ARGUMENT_BUILDER_EMPTY_CONSUME_REMAINING - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_BUILDER_EMPTY_NAME - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_BUILDER_NEGATIVE_MAXIMUM - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_BUILDER_NEGATIVE_MINIMUM - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_BUILDER_NULL_CONSUME_REMAINING - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_BUILDER_NULL_DEFAULT - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_BUILDER_NULL_DEFAULTS - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_BUILDER_NULL_NAME - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_BUILDER_NULL_VALIDATOR - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_MIN_EXCEEDS_MAX - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_MISSING_VALUES - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_TOO_FEW_DEFAULTS - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_TOO_MANY_DEFAULTS - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_TOO_MANY_VALUES - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ARGUMENT_UNEXPECTED_VALUE - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
ArgumentBuilder - Class in org.apache.commons.cli2.builder
Builds Argument instances.
ArgumentBuilder() - Constructor for class org.apache.commons.cli2.builder.ArgumentBuilder
Creates a new ArgumentBuilder instance
ArgumentImpl - Class in org.apache.commons.cli2.option
An implementation of an Argument.
ArgumentImpl(String, String, int, int, char, char, Validator, String, List, int) - Constructor for class org.apache.commons.cli2.option.ArgumentImpl
Creates a new Argument instance.

B

bundle - Variable in class org.apache.commons.cli2.resource.ResourceHelper
resource bundle
burstAliases - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
burstAliases - Variable in class org.apache.commons.cli2.option.DefaultOption
 
burstEnabled - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
burstEnabled - Variable in class org.apache.commons.cli2.option.DefaultOption
 
burstLength - Variable in class org.apache.commons.cli2.option.DefaultOption
 

C

cachedComparator - Variable in class org.apache.commons.cli2.option.HelpLineImpl
The comparator used to obtain the previous usage
cachedHelpSettings - Variable in class org.apache.commons.cli2.option.HelpLineImpl
The help settings used to obtain the previous usage
cachedUsage - Variable in class org.apache.commons.cli2.option.HelpLineImpl
The previously obtained usage
CANNOT_BURST - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
canProcess(WriteableCommandLine, String) - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
canProcess(WriteableCommandLine, String) - Method in interface org.apache.commons.cli2.Option
Indicates whether this Option will be able to process the particular argument.
canProcess(WriteableCommandLine, ListIterator) - Method in interface org.apache.commons.cli2.Option
Indicates whether this Option will be able to process the particular argument.
canProcess(WriteableCommandLine, String) - Method in class org.apache.commons.cli2.option.DefaultOption
 
canProcess(WriteableCommandLine, String) - Method in class org.apache.commons.cli2.option.GroupImpl
 
canProcess(WriteableCommandLine, ListIterator) - Method in class org.apache.commons.cli2.option.OptionImpl
 
canProcess(WriteableCommandLine, String) - Method in class org.apache.commons.cli2.option.ParentImpl
 
canProcess(WriteableCommandLine, String) - Method in class org.apache.commons.cli2.option.PropertyOption
 
canProcess(WriteableCommandLine, String) - Method in class org.apache.commons.cli2.option.SourceDestArgument
 
chain(Comparator, Comparator) - Static method in class org.apache.commons.cli2.util.Comparators
Chains comparators together.
chain(Comparator, Comparator, Comparator) - Static method in class org.apache.commons.cli2.util.Comparators
Chains comparators together.
chain(Comparator, Comparator, Comparator, Comparator) - Static method in class org.apache.commons.cli2.util.Comparators
Chains comparators together.
chain(Comparator, Comparator, Comparator, Comparator, Comparator) - Static method in class org.apache.commons.cli2.util.Comparators
Chains comparators together.
chain(List) - Static method in class org.apache.commons.cli2.util.Comparators
Chains comparators together.
chain(Comparator[]) - Static method in class org.apache.commons.cli2.util.Comparators
Chains an array of comparators together.
chain - Variable in class org.apache.commons.cli2.util.Comparators.Chain
 
checkPrefix(Set, String) - Method in class org.apache.commons.cli2.option.OptionImpl
 
checkPrefixes(Set) - Method in class org.apache.commons.cli2.option.OptionImpl
 
children - Variable in class org.apache.commons.cli2.builder.CommandBuilder
the children of the command
children - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
children - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
children - Variable in class org.apache.commons.cli2.option.ParentImpl
 
ClassValidator - Class in org.apache.commons.cli2.validation
The ClassValidator validates the string argument values are class names.
ClassValidator() - Constructor for class org.apache.commons.cli2.validation.ClassValidator
 
CLASSVALIDATOR_BAD_CLASSNAME - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
CLASSVALIDATOR_CLASS_ACCESS - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
CLASSVALIDATOR_CLASS_CREATE - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
CLASSVALIDATOR_CLASS_NOTFOUND - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
Command - Class in org.apache.commons.cli2.option
Represents a cvs "update" style command line option.
Command(String, String, Set, boolean, Argument, Group, int) - Constructor for class org.apache.commons.cli2.option.Command
Creates a new Command instance.
COMMAND_PREFERRED_NAME_TOO_SHORT - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
CommandBuilder - Class in org.apache.commons.cli2.builder
Builds Command instances
CommandBuilder() - Constructor for class org.apache.commons.cli2.builder.CommandBuilder
Creates a new CommandBuilder instance.
commandFirst() - Static method in class org.apache.commons.cli2.util.Comparators
Forces Command instances to appear at the beginning of lists
commandLast() - Static method in class org.apache.commons.cli2.util.Comparators
Forces Command instances to appear at the end of lists
CommandLine - Interface in org.apache.commons.cli2
Instances of CommandLine represent a command line that has been processed according to the definition supplied to the parser.
CommandLineImpl - Class in org.apache.commons.cli2.commandline
Instances of CommandLine represent a command line that has been processed according to the definition supplied to the parser.
CommandLineImpl() - Constructor for class org.apache.commons.cli2.commandline.CommandLineImpl
 
commandLines - Variable in class org.apache.commons.cli2.commandline.DefaultingCommandLine
The list of default CommandLine instances
commandLines() - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
Builds an iterator over the build in CommandLines.
comparator - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
Comparators - Class in org.apache.commons.cli2.util
A collection of Comparators suitable for use with Option instances.
Comparators() - Constructor for class org.apache.commons.cli2.util.Comparators
 
Comparators.Chain - Class in org.apache.commons.cli2.util
Chains a series of Comparators together.
Comparators.Chain(Comparator[]) - Constructor for class org.apache.commons.cli2.util.Comparators.Chain
Creates a Comparator chain using the specified array of Comparators
Comparators.CommandFirst - Class in org.apache.commons.cli2.util
 
Comparators.CommandFirst() - Constructor for class org.apache.commons.cli2.util.Comparators.CommandFirst
 
Comparators.DefaultOptionFirst - Class in org.apache.commons.cli2.util
 
Comparators.DefaultOptionFirst() - Constructor for class org.apache.commons.cli2.util.Comparators.DefaultOptionFirst
 
Comparators.GroupFirst - Class in org.apache.commons.cli2.util
 
Comparators.GroupFirst() - Constructor for class org.apache.commons.cli2.util.Comparators.GroupFirst
 
Comparators.Named - Class in org.apache.commons.cli2.util
 
Comparators.Named(String) - Constructor for class org.apache.commons.cli2.util.Comparators.Named
Creates a Comparator that sorts a particular name high in order
Comparators.PreferredName - Class in org.apache.commons.cli2.util
 
Comparators.PreferredName() - Constructor for class org.apache.commons.cli2.util.Comparators.PreferredName
 
Comparators.Required - Class in org.apache.commons.cli2.util
 
Comparators.Required() - Constructor for class org.apache.commons.cli2.util.Comparators.Required
 
Comparators.Reverse - Class in org.apache.commons.cli2.util
 
Comparators.Reverse(Comparator) - Constructor for class org.apache.commons.cli2.util.Comparators.Reverse
Creates a Comparator with reverse logic
Comparators.SwitchFirst - Class in org.apache.commons.cli2.util
 
Comparators.SwitchFirst() - Constructor for class org.apache.commons.cli2.util.Comparators.SwitchFirst
 
compare(Object, Object) - Method in class org.apache.commons.cli2.option.ReverseStringComparator
 
compare(Object, Object) - Method in class org.apache.commons.cli2.util.Comparators.Chain
 
compare(Object, Object) - Method in class org.apache.commons.cli2.util.Comparators.CommandFirst
 
compare(Object, Object) - Method in class org.apache.commons.cli2.util.Comparators.DefaultOptionFirst
 
compare(Object, Object) - Method in class org.apache.commons.cli2.util.Comparators.GroupFirst
 
compare(Object, Object) - Method in class org.apache.commons.cli2.util.Comparators.Named
 
compare(Object, Object) - Method in class org.apache.commons.cli2.util.Comparators.PreferredName
 
compare(Object, Object) - Method in class org.apache.commons.cli2.util.Comparators.Required
 
compare(Object, Object) - Method in class org.apache.commons.cli2.util.Comparators.Reverse
 
compare(Object, Object) - Method in class org.apache.commons.cli2.util.Comparators.SwitchFirst
 
consumeRemaining - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
used to identify the consume remaining option, typically "--"
consumeRemaining - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
create() - Method in class org.apache.commons.cli2.builder.ArgumentBuilder
Creates a new Argument instance using the options specified in this ArgumentBuilder.
create() - Method in class org.apache.commons.cli2.builder.CommandBuilder
Creates a new Command instance using the properties of the CommandBuilder.
create() - Method in class org.apache.commons.cli2.builder.DefaultOptionBuilder
Creates a DefaultOption instance
create() - Method in class org.apache.commons.cli2.builder.GroupBuilder
Creates a new Group instance
create() - Method in class org.apache.commons.cli2.builder.PatternBuilder
Creates a new Option instance.
create() - Method in class org.apache.commons.cli2.builder.SwitchBuilder
Creates a new Switch instance
createOption(char, boolean, char) - Method in class org.apache.commons.cli2.builder.PatternBuilder
 

D

DateValidator - Class in org.apache.commons.cli2.validation
The DateValidator validates the argument values are date or time value(s).
DateValidator() - Constructor for class org.apache.commons.cli2.validation.DateValidator
Creates a Validator for the default date/time format
DateValidator(DateFormat) - Constructor for class org.apache.commons.cli2.validation.DateValidator
Creates a Validator for the specified DateFormat.
DateValidator(List) - Constructor for class org.apache.commons.cli2.validation.DateValidator
Creates a Validator for the List of specified DateFormats.
DATEVALIDATOR_DATE_OUTOFRANGE - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
DEFAULT_BUNDLE - Static variable in class org.apache.commons.cli2.resource.ResourceHelper
default package name
DEFAULT_BURST_ENABLED - Static variable in class org.apache.commons.cli2.option.DefaultOption
The default value for the burstEnabled constructor parameter
DEFAULT_CONSUME_REMAINING - Static variable in class org.apache.commons.cli2.option.ArgumentImpl
The default token to indicate that remaining arguments should be consumed as values.
DEFAULT_DESCRIPTION - Static variable in class org.apache.commons.cli2.option.PropertyOption
 
DEFAULT_DISABLED_PREFIX - Static variable in class org.apache.commons.cli2.option.Switch
The default prefix for disabled switches
DEFAULT_DISPLAY_USAGE_SETTINGS - Static variable in class org.apache.commons.cli2.util.HelpFormatter
The default DisplaySettings used to select the help lines in the main body of help
DEFAULT_ENABLED_PREFIX - Static variable in class org.apache.commons.cli2.option.Switch
The default prefix for enabled switches
DEFAULT_FULL_USAGE_SETTINGS - Static variable in class org.apache.commons.cli2.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 org.apache.commons.cli2.util.HelpFormatter
The default screen width
DEFAULT_GUTTER_CENTER - Static variable in class org.apache.commons.cli2.util.HelpFormatter
The default screen furniture right of screen
DEFAULT_GUTTER_LEFT - Static variable in class org.apache.commons.cli2.util.HelpFormatter
The default screen furniture left of screen
DEFAULT_GUTTER_RIGHT - Static variable in class org.apache.commons.cli2.util.HelpFormatter
The default screen furniture between columns
DEFAULT_INITIAL_SEPARATOR - Static variable in class org.apache.commons.cli2.option.ArgumentImpl
The default value for the initial separator char.
DEFAULT_LINE_USAGE_SETTINGS - Static variable in class org.apache.commons.cli2.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 org.apache.commons.cli2.option.DefaultOption
The default token used to prefix a long option
DEFAULT_OPTION_STRING - Static variable in class org.apache.commons.cli2.option.PropertyOption
 
DEFAULT_SHORT_PREFIX - Static variable in class org.apache.commons.cli2.option.DefaultOption
The default token used to prefix a short option
DEFAULT_SUBSEQUENT_SEPARATOR - Static variable in class org.apache.commons.cli2.option.ArgumentImpl
The default value for the subsequent separator char.
DefaultingCommandLine - Class in org.apache.commons.cli2.commandline
Manages a queue of default CommandLines.
DefaultingCommandLine() - Constructor for class org.apache.commons.cli2.commandline.DefaultingCommandLine
 
DefaultOption - Class in org.apache.commons.cli2.option
A Parent implementation representing normal options.
DefaultOption(String, String, boolean, String, String, Set, Set, boolean, Argument, Group, int) - Constructor for class org.apache.commons.cli2.option.DefaultOption
Creates a new DefaultOption
DefaultOptionBuilder - Class in org.apache.commons.cli2.builder
Builds DefaultOption instances.
DefaultOptionBuilder() - Constructor for class org.apache.commons.cli2.builder.DefaultOptionBuilder
Creates a new DefaultOptionBuilder using defaults
DefaultOptionBuilder(String, String, boolean) - Constructor for class org.apache.commons.cli2.builder.DefaultOptionBuilder
Creates a new DefaultOptionBuilder
defaultOptionFirst() - Static method in class org.apache.commons.cli2.util.Comparators
Forces DefaultOption instances to appear at the beginning of lists
defaultOptionLast() - Static method in class org.apache.commons.cli2.util.Comparators
Forces DefaultOption instances to appear at the end of lists
defaults(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
defaults(WriteableCommandLine) - Method in interface org.apache.commons.cli2.Option
Adds defaults to a CommandLine.
defaults(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.GroupImpl
 
defaults(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.OptionImpl
 
defaults(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.ParentImpl
 
defaults(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.Switch
 
defaultSwitch - Variable in class org.apache.commons.cli2.option.Switch
 
defaultSwitches - Variable in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
defaultValues(WriteableCommandLine, Option) - Method in interface org.apache.commons.cli2.Argument
Adds defaults to a CommandLine.
defaultValues - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
default values for argument
defaultValues - Variable in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
defaultValues - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
defaultValues(WriteableCommandLine, Option) - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
description - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
description of the argument.
description - Variable in class org.apache.commons.cli2.builder.CommandBuilder
the description of the command
description - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
description - Variable in class org.apache.commons.cli2.builder.GroupBuilder
 
description - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
description - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
description - Variable in class org.apache.commons.cli2.option.GroupImpl
 
description - Variable in class org.apache.commons.cli2.option.ParentImpl
 
description - Variable in class org.apache.commons.cli2.option.PropertyOption
 
dest - Variable in class org.apache.commons.cli2.option.SourceDestArgument
 
directory - Variable in class org.apache.commons.cli2.validation.FileValidator
whether the argument value is a directory
disabledPrefix - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
disabledPrefix - Variable in class org.apache.commons.cli2.option.Switch
 
DISPLAY_ALIASES - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that aliases should be included
DISPLAY_ARGUMENT_BRACKETED - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that arguments should be included bracketed
DISPLAY_ARGUMENT_NUMBERED - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that arguments should be included numbered
DISPLAY_GROUP_ARGUMENT - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that group arguments should be included
DISPLAY_GROUP_EXPANDED - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that groups should be included expanded
DISPLAY_GROUP_NAME - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that group names should be included
DISPLAY_GROUP_OUTER - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that group outer brackets should be included
DISPLAY_OPTIONAL - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that optionality should be included
DISPLAY_PARENT_ARGUMENT - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that arguments of Parents should be included
DISPLAY_PARENT_CHILDREN - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that children of Parents should be included
DISPLAY_PROPERTY_OPTION - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that property options should be included
DISPLAY_SWITCH_DISABLED - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that switches should be included disabled
DISPLAY_SWITCH_ENABLED - Static variable in class org.apache.commons.cli2.DisplaySetting
Indicates that switches should be included enabled
DisplaySetting - Class in org.apache.commons.cli2
An enum of possible display settings.
DisplaySetting(String) - Constructor for class org.apache.commons.cli2.DisplaySetting
Creates a new DisplaySetting with the specified name
displaySettings - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
divider - Variable in class org.apache.commons.cli2.util.HelpFormatter
 

E

enabledPrefix - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
enabledPrefix - Variable in class org.apache.commons.cli2.option.Switch
 
ENUM_ILLEGAL_VALUE - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
EnumValidator - Class in org.apache.commons.cli2.validation
The EnumValidator validates the string argument values are valid.
EnumValidator(Set) - Constructor for class org.apache.commons.cli2.validation.EnumValidator
Creates a new EnumValidator for the specified values.
equals(Object) - Method in class org.apache.commons.cli2.DisplaySetting
 
equals(Object) - Method in class org.apache.commons.cli2.option.OptionImpl
 
equals(Object, Object) - Method in class org.apache.commons.cli2.option.OptionImpl
 
exception - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
existing - Variable in class org.apache.commons.cli2.validation.FileValidator
whether the argument value exists

F

file - Variable in class org.apache.commons.cli2.validation.FileValidator
whether the argument value is a file
FileValidator - Class in org.apache.commons.cli2.validation
The FileValidator validates the string argument values are files.
FileValidator() - Constructor for class org.apache.commons.cli2.validation.FileValidator
 
findOption(String) - Method in interface org.apache.commons.cli2.Option
Recursively searches for an option with the supplied trigger.
findOption(String) - Method in class org.apache.commons.cli2.option.GroupImpl
 
findOption(String) - Method in class org.apache.commons.cli2.option.OptionImpl
 
findOption(String) - Method in class org.apache.commons.cli2.option.ParentImpl
 
footer - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
format - Variable in class org.apache.commons.cli2.validation.NumberValidator
the NumberFormat being used.
formats - Variable in class org.apache.commons.cli2.validation.DateValidator
an array of permitted DateFormats
fullUsageSettings - Variable in class org.apache.commons.cli2.util.HelpFormatter
 

G

gbuilder - Variable in class org.apache.commons.cli2.builder.PatternBuilder
 
getAnonymous() - Method in class org.apache.commons.cli2.option.GroupImpl
Gets the anonymous Arguments of this Group.
getArgument() - Method in class org.apache.commons.cli2.option.ParentImpl
 
getBundleName() - Method in class org.apache.commons.cli2.resource.ResourceHelper
 
getChildren() - Method in class org.apache.commons.cli2.option.ParentImpl
 
getClassLoader() - Method in class org.apache.commons.cli2.validation.ClassValidator
Returns the ClassLoader used to resolve and load the classes specified by the argument values.
getComparator() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getConsumeRemaining() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getCurrencyInstance() - Static method in class org.apache.commons.cli2.validation.NumberValidator
Returns a NumberValidator for a currency format for the current default locale.
getDateInstance() - Static method in class org.apache.commons.cli2.validation.DateValidator
Creates a Validator for dates.
getDateTimeInstance() - Static method in class org.apache.commons.cli2.validation.DateValidator
Creates a Validator for date/times
getDefaultValues() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getDescription() - Method in interface org.apache.commons.cli2.HelpLine
 
getDescription() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getDescription() - Method in interface org.apache.commons.cli2.Option
Returns a description of the option.
getDescription() - Method in class org.apache.commons.cli2.option.GroupImpl
 
getDescription() - Method in class org.apache.commons.cli2.option.HelpLineImpl
 
getDescription() - Method in class org.apache.commons.cli2.option.ParentImpl
 
getDescription() - Method in class org.apache.commons.cli2.option.PropertyOption
 
getDisplaySettings() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getDivider() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getException() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getExistingDirectoryInstance() - Static method in class org.apache.commons.cli2.validation.FileValidator
Returns a FileValidator for existing directories.
getExistingFileInstance() - Static method in class org.apache.commons.cli2.validation.FileValidator
Returns a FileValidator for existing files.
getExistingInstance() - Static method in class org.apache.commons.cli2.validation.FileValidator
Returns a FileValidator for existing files/directories.
getFooter() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getFormat() - Method in class org.apache.commons.cli2.validation.NumberValidator
Return the format being used to validate argument values against.
getFormats() - Method in class org.apache.commons.cli2.validation.DateValidator
Gets the date formats permitted.
getFullUsageSettings() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getGroup() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getGutterCenter() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getGutterLeft() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getGutterRight() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getHeader() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getId() - Method in interface org.apache.commons.cli2.Option
Returns the id of the option.
getId() - Method in class org.apache.commons.cli2.option.OptionImpl
 
getIndent() - Method in interface org.apache.commons.cli2.HelpLine
 
getIndent() - Method in class org.apache.commons.cli2.option.HelpLineImpl
 
getInitialSeparator() - Method in interface org.apache.commons.cli2.Argument
Returns the initial separator character or '\0' if no character has been set.
getInitialSeparator() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getInstance() - Static method in class org.apache.commons.cli2.option.ReverseStringComparator
Gets a singleton instance of a ReverseStringComparator
getIntegerInstance() - Static method in class org.apache.commons.cli2.validation.NumberValidator
Returns a NumberValidator for an integer number format for the current default locale.
getLineUsageSettings() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getMaximum() - Method in interface org.apache.commons.cli2.Argument
Retrieves the maximum number of values acceptable for a valid Argument
getMaximum() - Method in interface org.apache.commons.cli2.Group
Retrieves the maximum number of members acceptable for a valid Group
getMaximum() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getMaximum() - Method in class org.apache.commons.cli2.option.GroupImpl
 
getMaximum() - Method in class org.apache.commons.cli2.validation.DateValidator
Returns the maximum date permitted.
getMaximum() - Method in class org.apache.commons.cli2.validation.NumberValidator
Return the maximum value allowed for an argument value.
getMessage() - Method in exception org.apache.commons.cli2.OptionException
 
getMessage(String) - Method in class org.apache.commons.cli2.resource.ResourceHelper
Returns the message for the specified key.
getMessage(String, Object) - Method in class org.apache.commons.cli2.resource.ResourceHelper
Returns the message for the specified key and argument.
getMessage(String, Object, Object) - Method in class org.apache.commons.cli2.resource.ResourceHelper
Returns the message for the specified key and arguments.
getMessage(String, Object, Object, Object) - Method in class org.apache.commons.cli2.resource.ResourceHelper
Returns the message for the specified key and arguments.
getMessage(String, Object[]) - Method in class org.apache.commons.cli2.resource.ResourceHelper
Returns the message for the specified key and arguments.
getMinimum() - Method in interface org.apache.commons.cli2.Argument
Retrieves the minimum number of values required for a valid Argument
getMinimum() - Method in interface org.apache.commons.cli2.Group
Retrieves the minimum number of members required for a valid Group
getMinimum() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getMinimum() - Method in class org.apache.commons.cli2.option.GroupImpl
 
getMinimum() - Method in class org.apache.commons.cli2.validation.DateValidator
Returns the minimum date permitted.
getMinimum() - Method in class org.apache.commons.cli2.validation.NumberValidator
Return the minimum value allowed for an argument value.
getNormalised() - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
getNumberInstance() - Static method in class org.apache.commons.cli2.validation.NumberValidator
Returns a NumberValidator for a general-purpose number format for the current default locale.
getOption(String) - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
 
getOption(String) - Method in interface org.apache.commons.cli2.CommandLine
Finds the Option with the specified trigger
getOption(String) - Method in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
getOption(String) - Method in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
getOption(String) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
getOption() - Method in interface org.apache.commons.cli2.HelpLine
 
getOption() - Method in class org.apache.commons.cli2.option.HelpLineImpl
 
getOption() - Method in exception org.apache.commons.cli2.OptionException
Gets the Option the exception relates to
getOptionCount(String) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getOptionCount(Option) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getOptionCount(String) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the number of times the specified Option appeared in this CommandLine
getOptionCount(Option) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the number of times the specified Option appeared in this CommandLine
getOptions() - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
 
getOptions() - Method in interface org.apache.commons.cli2.CommandLine
Retrieves a list of all Options found in this CommandLine
getOptions() - Method in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
getOptions() - Method in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
getOptions() - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
getOptions() - Method in class org.apache.commons.cli2.option.GroupImpl
Gets the member Options of thie Group.
getOptionTriggers() - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
 
getOptionTriggers() - Method in interface org.apache.commons.cli2.CommandLine
Retrieves a list of all Option triggers found in this CommandLine
getOptionTriggers() - Method in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
getOptionTriggers() - Method in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
getOptionTriggers() - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
getPageWidth() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getPercentInstance() - Static method in class org.apache.commons.cli2.validation.NumberValidator
Returns a NumberValidator for a percentage format for the current default locale.
getPreferredName() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getPreferredName() - Method in class org.apache.commons.cli2.option.Command
 
getPreferredName() - Method in class org.apache.commons.cli2.option.DefaultOption
 
getPreferredName() - Method in interface org.apache.commons.cli2.Option
The preferred name of an option is used for generating help and usage information.
getPreferredName() - Method in class org.apache.commons.cli2.option.GroupImpl
 
getPreferredName() - Method in class org.apache.commons.cli2.option.PropertyOption
 
getPreferredName() - Method in class org.apache.commons.cli2.option.Switch
 
getPrefixes() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getPrefixes() - Method in class org.apache.commons.cli2.option.DefaultOption
 
getPrefixes() - Method in interface org.apache.commons.cli2.Option
Identifies the argument prefixes that should be considered options.
getPrefixes() - Method in class org.apache.commons.cli2.option.GroupImpl
 
getPrefixes() - Method in class org.apache.commons.cli2.option.ParentImpl
 
getPrefixes() - Method in class org.apache.commons.cli2.option.PropertyOption
 
getPrefixes() - Method in class org.apache.commons.cli2.option.Switch
 
getPrintWriter() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getProperties() - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
 
getProperties() - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the set of all property names associated with this CommandLine
getProperties() - Method in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
getProperties() - Method in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
getProperties() - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
getProperty(String) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getProperty(String, String) - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
 
getProperty(String) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the value associated with the specified property
getProperty(String, String) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the value associated with the specified property
getProperty(String, String) - Method in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
getProperty(String, String) - Method in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
getProperty(String, String) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
getProtocol() - Method in class org.apache.commons.cli2.validation.UrlValidator
Returns the protocol that must be used by a valid URL.
getResourceHelper() - Static method in class org.apache.commons.cli2.resource.ResourceHelper
Gets the ResourceHelper appropriate to the current locale.
getShellCommand() - Method in class org.apache.commons.cli2.util.HelpFormatter
 
getSubsequentSeparator() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getSwitch(String) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getSwitch(String, Boolean) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getSwitch(Option) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getSwitch(Option, Boolean) - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
 
getSwitch(String) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(String, Boolean) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(Option) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(Option, Boolean) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the Boolean value associated with the specified Switch
getSwitch(Option, Boolean) - Method in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
getSwitch(Option, Boolean) - Method in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
getSwitch(Option, Boolean) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
getTimeInstance() - Static method in class org.apache.commons.cli2.validation.DateValidator
Creates a Validator for times.
getTriggers() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getTriggers() - Method in class org.apache.commons.cli2.option.Command
 
getTriggers() - Method in class org.apache.commons.cli2.option.DefaultOption
 
getTriggers() - Method in interface org.apache.commons.cli2.Option
Identifies the argument prefixes that should trigger this option.
getTriggers() - Method in class org.apache.commons.cli2.option.GroupImpl
 
getTriggers() - Method in class org.apache.commons.cli2.option.PropertyOption
 
getTriggers() - Method in class org.apache.commons.cli2.option.Switch
 
getValidator() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
getValidValues() - Method in class org.apache.commons.cli2.validation.EnumValidator
Returns the Set of valid argument values.
getValue(String) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getValue(String, Object) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getValue(Option) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getValue(Option, Object) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getValue(String) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the single Argument value associated with the specified Option
getValue(String, Object) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the single Argument value associated with the specified Option
getValue(Option) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the single Argument value associated with the specified Option
getValue(Option, Object) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the single Argument value associated with the specified Option
getValues(String) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getValues(String, List) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getValues(Option) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
getValues(Option, List) - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
 
getValues(String) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the Argument values associated with the specified Option
getValues(String, List) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the Argument values associated with the specified Option
getValues(Option) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the Argument values associated with the specified Option
getValues(Option, List) - Method in interface org.apache.commons.cli2.CommandLine
Retrieves the Argument values associated with the specified Option
getValues(Option, List) - Method in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
getValues(Option, List) - Method in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
getValues(Option, List) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
getValuesAsString() - Method in class org.apache.commons.cli2.validation.EnumValidator
Returns the permitted values in a comma separated String
group - Variable in class org.apache.commons.cli2.commandline.Parser
 
Group - Interface in org.apache.commons.cli2
An Option representing a choice or group of Options in the form "-a|-b|-c".
group - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
GroupBuilder - Class in org.apache.commons.cli2.builder
Builds Group instances
GroupBuilder() - Constructor for class org.apache.commons.cli2.builder.GroupBuilder
Creates a new GroupBuilder
groupFirst() - Static method in class org.apache.commons.cli2.util.Comparators
Forces Group instances to appear at the beginning of lists
GroupImpl - Class in org.apache.commons.cli2.option
An implementation of Group
GroupImpl(List, String, String, int, int) - Constructor for class org.apache.commons.cli2.option.GroupImpl
Creates a new GroupImpl using the specified parameters.
groupLast() - Static method in class org.apache.commons.cli2.util.Comparators
Forces Group instances to appear at the end of lists
gutterCenter - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
gutterLeft - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
gutterRight - Variable in class org.apache.commons.cli2.util.HelpFormatter
 

H

handleInitialSeparator(ListIterator, char) - Method in class org.apache.commons.cli2.option.ParentImpl
Split the token using the specified separator character.
hashCode - Variable in class org.apache.commons.cli2.DisplaySetting
The hashCode of the setting
hashCode() - Method in class org.apache.commons.cli2.DisplaySetting
 
hashCode() - Method in class org.apache.commons.cli2.option.OptionImpl
 
hasOption(String) - Method in class org.apache.commons.cli2.commandline.CommandLineImpl
 
hasOption(Option) - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
 
hasOption(String) - Method in interface org.apache.commons.cli2.CommandLine
Detects the presence of an option with the specified trigger in this CommandLine.
hasOption(Option) - Method in interface org.apache.commons.cli2.CommandLine
Detects the presence of an option in this CommandLine.
hasOption(Option) - Method in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
hasOption(Option) - Method in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
hasOption(Option) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
header - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
HELP_SETTINGS - Static variable in exception org.apache.commons.cli2.OptionException
The settings used when displaying the related Option.
helper - Static variable in exception org.apache.commons.cli2.OptionException
resource helper instance
helper - Static variable in class org.apache.commons.cli2.resource.ResourceHelper
 
helpFormatter - Variable in class org.apache.commons.cli2.commandline.Parser
 
HelpFormatter - Class in org.apache.commons.cli2.util
Presents on screen help based on the application's Options
HelpFormatter() - Constructor for class org.apache.commons.cli2.util.HelpFormatter
Creates a new HelpFormatter using the defaults
HelpFormatter(String, String, String, int) - Constructor for class org.apache.commons.cli2.util.HelpFormatter
Creates a new HelpFormatter using the specified parameters
HELPFORMATTER_GUTTER_TOO_LONG - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
HELPFORMATTER_WIDTH_TOO_NARROW - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
HelpLine - Interface in org.apache.commons.cli2
Represents a line of help for a particular Option.
HelpLineImpl - Class in org.apache.commons.cli2.option
Represents a line in the help screen.
HelpLineImpl(Option, int) - Constructor for class org.apache.commons.cli2.option.HelpLineImpl
Creates a new HelpLineImpl to represent a particular Option in the online help.
helpLines(int, Set, Comparator) - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
helpLines(int, Set, Comparator) - Method in class org.apache.commons.cli2.option.GroupImpl
 
helpLines(int, Set, Comparator) - Method in interface org.apache.commons.cli2.Option
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
helpLines(int, Set, Comparator) - Method in class org.apache.commons.cli2.option.ParentImpl
 
helpLines(int, Set, Comparator) - Method in class org.apache.commons.cli2.option.PropertyOption
 
helpLines(int, Set, Comparator) - Method in class org.apache.commons.cli2.option.SourceDestArgument
 
helpOption - Variable in class org.apache.commons.cli2.commandline.Parser
 
helpTrigger - Variable in class org.apache.commons.cli2.commandline.Parser
 
hidden - Variable in class org.apache.commons.cli2.validation.FileValidator
whether the argument value is a hidden file or directory

I

id - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
id of the argument
id - Variable in class org.apache.commons.cli2.builder.CommandBuilder
the id of the command
id - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
id - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
id - Variable in class org.apache.commons.cli2.option.OptionImpl
 
indent - Variable in class org.apache.commons.cli2.option.HelpLineImpl
The level of indenting for this item
initialSeparator - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
character used to separate the values from the option
initialSeparator - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
insertCommandLine(int, CommandLine) - Method in class org.apache.commons.cli2.commandline.DefaultingCommandLine
Adds a CommandLine instance to a specified position in the queue.
INSTANCE - Static variable in class org.apache.commons.cli2.option.PropertyOption
A default PropertyOption instance
instance - Static variable in class org.apache.commons.cli2.option.ReverseStringComparator
 
instance - Variable in class org.apache.commons.cli2.validation.ClassValidator
whether to create an instance of the class
InvalidArgumentException - Exception in org.apache.commons.cli2.validation
An exception indicating validation failure.
InvalidArgumentException(String) - Constructor for exception org.apache.commons.cli2.validation.InvalidArgumentException
Creates a new exception
isDateEarlier(Date) - Method in class org.apache.commons.cli2.validation.DateValidator
Returns whether the specified Date is earlier than the minimum date.
isDateLater(Date) - Method in class org.apache.commons.cli2.validation.DateValidator
Returns whether the specified Date is later than the maximum date.
isDirectory() - Method in class org.apache.commons.cli2.validation.FileValidator
Returns whether the argument values must represent directories.
isExisting() - Method in class org.apache.commons.cli2.validation.FileValidator
Returns whether the argument values must represent existing files/directories.
isFile() - Method in class org.apache.commons.cli2.validation.FileValidator
Returns whether the argument values must represent directories.
isHidden() - Method in class org.apache.commons.cli2.validation.FileValidator
Returns whether the argument values must represent hidden files/directories.
isInstance() - Method in class org.apache.commons.cli2.validation.ClassValidator
Returns whether the argument value must represent a class that can be instantiated.
isLenient - Variable in class org.apache.commons.cli2.validation.DateValidator
leniant parsing
isLenient() - Method in class org.apache.commons.cli2.validation.DateValidator
Returns whether this validator uses lenient parsing.
isLoadable() - Method in class org.apache.commons.cli2.validation.ClassValidator
Returns whether the argument value must represent a class that is loadable.
isPotentialClassName(String) - Method in class org.apache.commons.cli2.validation.ClassValidator
Returns whether the specified name is allowed as a Java class name.
isReadable() - Method in class org.apache.commons.cli2.validation.FileValidator
Returns whether the argument values must represent readable files/directories.
isRequired() - Method in interface org.apache.commons.cli2.Argument
Indicates whether argument values must be present for the CommandLine to be valid.
isRequired() - Method in interface org.apache.commons.cli2.Group
Indicates whether group members must be present for the CommandLine to be valid.
isRequired() - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
isRequired() - Method in class org.apache.commons.cli2.option.GroupImpl
 
isRequired() - Method in interface org.apache.commons.cli2.Option
Indicates whether this option is required to be present.
isRequired() - Method in class org.apache.commons.cli2.option.OptionImpl
 
isWritable() - Method in class org.apache.commons.cli2.validation.FileValidator
Returns whether the argument values must represent writable files/directories.

L

lineUsageSettings - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
loadable - Variable in class org.apache.commons.cli2.validation.ClassValidator
whether the class argument is loadable
loader - Variable in class org.apache.commons.cli2.validation.ClassValidator
the classloader to load classes from
longPrefix - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
looksLikeOption(String) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
looksLikeOption(String) - Method in interface org.apache.commons.cli2.WriteableCommandLine
Detects whether the argument looks like an Option trigger

M

maximum - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
maximum number of values permitted
maximum - Variable in class org.apache.commons.cli2.builder.GroupBuilder
 
maximum - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
maximum - Variable in class org.apache.commons.cli2.option.GroupImpl
 
maximum - Variable in class org.apache.commons.cli2.validation.DateValidator
maximum Date allowed i.e: a valid date occurs earlier than this date
maximum - Variable in class org.apache.commons.cli2.validation.NumberValidator
the upper bound for argument values
message - Variable in exception org.apache.commons.cli2.OptionException
The message explaining the Exception
minimum - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
minimum number of values required
minimum - Variable in class org.apache.commons.cli2.builder.GroupBuilder
 
minimum - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
minimum - Variable in class org.apache.commons.cli2.option.GroupImpl
 
minimum - Variable in class org.apache.commons.cli2.validation.DateValidator
minimum Date allowed i.e: a valid date occurs later than this date
minimum - Variable in class org.apache.commons.cli2.validation.NumberValidator
the lower bound for argument values.
MISSING_OPTION - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 

N

name - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
name of the argument.
name - Variable in class org.apache.commons.cli2.builder.GroupBuilder
 
name - Variable in class org.apache.commons.cli2.DisplaySetting
The name of the setting
name - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
name - Variable in class org.apache.commons.cli2.option.GroupImpl
 
name - Variable in class org.apache.commons.cli2.util.Comparators.Named
 
namedFirst(String) - Static method in class org.apache.commons.cli2.util.Comparators
Forces Comparators with a particular trigger to appear at the beginning of lists
namedLast(String) - Static method in class org.apache.commons.cli2.util.Comparators
Forces Comparators with a particular trigger to appear at the end of lists
nameToOption - Variable in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
NONE - Static variable in class org.apache.commons.cli2.DisplaySetting
A Set guarenteed to contain no DisplaySetting values
normalised - Variable in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
NUL - Static variable in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
NUL - Static variable in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
NUL - Static variable in class org.apache.commons.cli2.option.ArgumentImpl
 
NUL - Static variable in class org.apache.commons.cli2.option.ParentImpl
 
NumberValidator - Class in org.apache.commons.cli2.validation
The NumberValidator validates the string argument values are numbers.
NumberValidator(NumberFormat) - Constructor for class org.apache.commons.cli2.validation.NumberValidator
Creates a new NumberValidator based on the specified NumberFormat
NUMBERVALIDATOR_NUMBER_OUTOFRANGE - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 

O

obuilder - Variable in class org.apache.commons.cli2.builder.PatternBuilder
 
Option - Interface in org.apache.commons.cli2
The super type of all options representing a particular element of the command line interface.
option - Variable in class org.apache.commons.cli2.option.HelpLineImpl
The option that this HelpLineImpl describes
option - Variable in exception org.apache.commons.cli2.OptionException
The Option the exception relates to
OPTION_ILLEGAL_LONG_PREFIX - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
OPTION_ILLEGAL_SHORT_PREFIX - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
OPTION_MISSING_REQUIRED - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
OPTION_NO_NAME - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
OPTION_TRIGGER_NEEDS_PREFIX - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
OptionException - Exception in org.apache.commons.cli2
A problem found while dealing with command line options.
OptionException(Option) - Constructor for exception org.apache.commons.cli2.OptionException
Creates a new OptionException.
OptionException(Option, String) - Constructor for exception org.apache.commons.cli2.OptionException
Creates a new OptionException.
OptionException(Option, String, String) - Constructor for exception org.apache.commons.cli2.OptionException
Creates a new OptionException.
OptionImpl - Class in org.apache.commons.cli2.option
A base implementation of Option providing limited ground work for further Option implementations.
OptionImpl(int, boolean) - Constructor for class org.apache.commons.cli2.option.OptionImpl
Creates an OptionImpl with the specified id
optionMap - Variable in class org.apache.commons.cli2.option.GroupImpl
 
options - Variable in class org.apache.commons.cli2.builder.GroupBuilder
 
options - Variable in class org.apache.commons.cli2.builder.PatternBuilder
 
options - Variable in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
options - Variable in class org.apache.commons.cli2.option.GroupImpl
 
optionString - Variable in class org.apache.commons.cli2.option.PropertyOption
 
org.apache.commons.cli2 - package org.apache.commons.cli2
 
org.apache.commons.cli2.builder - package org.apache.commons.cli2.builder
 
org.apache.commons.cli2.commandline - package org.apache.commons.cli2.commandline
 
org.apache.commons.cli2.option - package org.apache.commons.cli2.option
 
org.apache.commons.cli2.resource - package org.apache.commons.cli2.resource
 
org.apache.commons.cli2.util - package org.apache.commons.cli2.util
 
org.apache.commons.cli2.validation - package org.apache.commons.cli2.validation
Provides classes and interfaces for validating argument values.
out - Variable in class org.apache.commons.cli2.util.HelpFormatter
 

P

pad(String, int, PrintWriter) - Static method in class org.apache.commons.cli2.util.HelpFormatter
 
pageWidth - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
Parent - Interface in org.apache.commons.cli2
An Option that can have an argument and/or group of child Options in the form "-f <arg> [-a|-b|-c]".
ParentImpl - Class in org.apache.commons.cli2.option
A base implementation of Parent providing limited ground work for further Parent implementations.
ParentImpl(Argument, Group, String, int, boolean) - Constructor for class org.apache.commons.cli2.option.ParentImpl
 
parse(String[]) - Method in class org.apache.commons.cli2.commandline.Parser
Parse the arguments according to the specified options and properties.
parseAndHelp(String[]) - Method in class org.apache.commons.cli2.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 org.apache.commons.cli2.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 org.apache.commons.cli2.commandline.Parser
 
PatternBuilder - Class in org.apache.commons.cli2.builder
Builds Options using a String pattern
PatternBuilder() - Constructor for class org.apache.commons.cli2.builder.PatternBuilder
Creates a new PatternBuilder
PatternBuilder(GroupBuilder, DefaultOptionBuilder, ArgumentBuilder) - Constructor for class org.apache.commons.cli2.builder.PatternBuilder
Creates a new PatternBuilder
preferences - Variable in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
PreferencesCommandLine - Class in org.apache.commons.cli2.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 org.apache.commons.cli2.commandline.PreferencesCommandLine
Creates a new PreferencesCommandLine using the specified root Option and Preferences node.
PreferencesCommandLine(Option, Preferences, char) - Constructor for class org.apache.commons.cli2.commandline.PreferencesCommandLine
Creates a new PreferencesCommandLine using the specified root Option, Preferences node and value separator.
preferredName - Variable in class org.apache.commons.cli2.builder.CommandBuilder
the preferred name of the command
preferredName - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
preferredName - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
preferredName - Variable in class org.apache.commons.cli2.option.Command
The display name for the command
preferredName - Variable in class org.apache.commons.cli2.option.DefaultOption
 
preferredName - Variable in class org.apache.commons.cli2.option.Switch
 
preferredNameFirst() - Static method in class org.apache.commons.cli2.util.Comparators
Orders Options by preferredName
preferredNameLast() - Static method in class org.apache.commons.cli2.util.Comparators
Orders Options by preferredName, reversed
prefixes - Variable in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
prefixes - Variable in class org.apache.commons.cli2.option.DefaultOption
 
prefixes - Variable in class org.apache.commons.cli2.option.GroupImpl
 
prefixes - Variable in class org.apache.commons.cli2.option.PropertyOption
 
prefixes - Variable in class org.apache.commons.cli2.option.Switch
 
print() - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints the Option help.
printDivider() - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints the divider text
printException() - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints any error message.
printFooter() - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints a footer string if necessary
printGutterLeft() - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints the left gutter string
printGutterRight() - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints the right gutter string
printHeader() - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints a header string if necessary
printHelp() - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints detailed help per option.
printUsage() - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints a single line of usage information (wrapping if necessary)
printWrapped(String) - Method in class org.apache.commons.cli2.util.HelpFormatter
Prints a string wrapped if necessary
process(WriteableCommandLine, ListIterator) - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
process(WriteableCommandLine, ListIterator) - Method in class org.apache.commons.cli2.option.GroupImpl
 
process(WriteableCommandLine, ListIterator) - Method in class org.apache.commons.cli2.option.ParentImpl
 
process(WriteableCommandLine, ListIterator) - Method in interface org.apache.commons.cli2.Option
Processes String arguments into a CommandLine.
process(WriteableCommandLine, ListIterator) - Method in class org.apache.commons.cli2.option.PropertyOption
 
processParent(WriteableCommandLine, ListIterator) - Method in class org.apache.commons.cli2.option.Command
 
processParent(WriteableCommandLine, ListIterator) - Method in class org.apache.commons.cli2.option.DefaultOption
 
processParent(WriteableCommandLine, ListIterator) - Method in class org.apache.commons.cli2.option.Switch
 
processParent(WriteableCommandLine, ListIterator) - Method in interface org.apache.commons.cli2.Parent
Processes the parent part of the Option.
processValues(WriteableCommandLine, ListIterator, Option) - Method in interface org.apache.commons.cli2.Argument
Processes the "README" style element of the argument.
processValues(WriteableCommandLine, ListIterator, Option) - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
prop - Variable in class org.apache.commons.cli2.resource.ResourceHelper
 
PROP_LOCALE - Static variable in class org.apache.commons.cli2.resource.ResourceHelper
system property
properties - Variable in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
properties - Variable in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
PropertiesCommandLine - Class in org.apache.commons.cli2.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 org.apache.commons.cli2.commandline.PropertiesCommandLine
Creates a new PropertiesCommandLine using the specified root Option, Properties instance.
PropertiesCommandLine(Option, Properties, char) - Constructor for class org.apache.commons.cli2.commandline.PropertiesCommandLine
Creates a new PropertiesCommandLine using the specified root Option, Properties instance and value separator.
PropertyOption - Class in org.apache.commons.cli2.option
Handles the java style "-Dprop=value" opions
PropertyOption() - Constructor for class org.apache.commons.cli2.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 org.apache.commons.cli2.option.PropertyOption
Creates a new PropertyOption using the specified parameters
protocol - Variable in class org.apache.commons.cli2.validation.UrlValidator
allowed protocol

R

readable - Variable in class org.apache.commons.cli2.validation.FileValidator
whether the argument value is readable
required - Variable in class org.apache.commons.cli2.builder.CommandBuilder
whether the command is required or not
required - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
required - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
required - Variable in class org.apache.commons.cli2.option.OptionImpl
 
requiredFirst() - Static method in class org.apache.commons.cli2.util.Comparators
Orders Options grouping required Options first
requiredLast() - Static method in class org.apache.commons.cli2.util.Comparators
Orders Options grouping required Options last
reset() - Method in class org.apache.commons.cli2.builder.ArgumentBuilder
Resets the ArgumentBuilder to the defaults for a new Argument.
reset() - Method in class org.apache.commons.cli2.builder.CommandBuilder
Resets the CommandBuilder to the defaults for a new Command.
reset() - Method in class org.apache.commons.cli2.builder.DefaultOptionBuilder
Resets the builder
reset() - Method in class org.apache.commons.cli2.builder.GroupBuilder
Resets the builder
reset() - Method in class org.apache.commons.cli2.builder.PatternBuilder
Resets this builder
reset() - Method in class org.apache.commons.cli2.builder.SwitchBuilder
Resets the builder
ResourceConstants - Class in org.apache.commons.cli2.resource
 
ResourceConstants() - Constructor for class org.apache.commons.cli2.resource.ResourceConstants
 
ResourceHelper - Class in org.apache.commons.cli2.resource
A utility class used to provide internationalisation support.
ResourceHelper() - Constructor for class org.apache.commons.cli2.resource.ResourceHelper
Create a new ResourceHelper for the current locale.
resources - Static variable in class org.apache.commons.cli2.builder.ArgumentBuilder
i18n
resources - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
resources - Static variable in class org.apache.commons.cli2.option.Switch
i18n
resources - Static variable in class org.apache.commons.cli2.validation.ClassValidator
i18n
resources - Static variable in class org.apache.commons.cli2.validation.DateValidator
i18n
reverse(Comparator) - Static method in class org.apache.commons.cli2.util.Comparators
Reverses a comparator's logic.
ReverseStringComparator - Class in org.apache.commons.cli2.option
 
ReverseStringComparator() - Constructor for class org.apache.commons.cli2.option.ReverseStringComparator
 
root - Variable in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
root - Variable in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 

S

separator - Variable in class org.apache.commons.cli2.commandline.PreferencesCommandLine
 
separator - Variable in class org.apache.commons.cli2.commandline.PropertiesCommandLine
 
setClassLoader(ClassLoader) - Method in class org.apache.commons.cli2.validation.ClassValidator
Specifies the ClassLoader used to resolve and load the classes specified by the argument values.
setComparator(Comparator) - Method in class org.apache.commons.cli2.util.HelpFormatter
The Comparator to use when sorting Options
setDefaultSwitch(Option, Boolean) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
setDefaultSwitch(Option, Boolean) - Method in interface org.apache.commons.cli2.WriteableCommandLine
Sets the default state for a Switch in the CommandLine.
setDefaultValues(Option, List) - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
setDefaultValues(Option, List) - Method in interface org.apache.commons.cli2.WriteableCommandLine
Sets the default values for an Option in the CommandLine
setDirectory(boolean) - Method in class org.apache.commons.cli2.validation.FileValidator
Specifies whether the argument values must represent directories.
setDisplaySettings(Set) - Method in class org.apache.commons.cli2.util.HelpFormatter
The DisplaySettings used to select the help lines in the main body of help
setDivider(String) - Method in class org.apache.commons.cli2.util.HelpFormatter
Sets the string to use as a divider between sections of help
setException(OptionException) - Method in class org.apache.commons.cli2.util.HelpFormatter
Sets the exception to document
setExisting(boolean) - Method in class org.apache.commons.cli2.validation.FileValidator
Specifies whether the argument values must represent existing files/directories.
setFile(boolean) - Method in class org.apache.commons.cli2.validation.FileValidator
Specifies whether the argument values must represent files.
setFooter(String) - Method in class org.apache.commons.cli2.util.HelpFormatter
Sets the footer text of the help screen
setFormat(DateFormat) - Method in class org.apache.commons.cli2.validation.DateValidator
Sets the date format permitted.
setFormat(NumberFormat) - Method in class org.apache.commons.cli2.validation.NumberValidator
Specify the format being used to validate argument values against.
setFormats(List) - Method in class org.apache.commons.cli2.validation.DateValidator
Sets the date formats permitted.
setFormats(DateFormat[]) - Method in class org.apache.commons.cli2.validation.DateValidator
Sets the date formats permitted.
setFullUsageSettings(Set) - Method in class org.apache.commons.cli2.util.HelpFormatter
The DisplaySettings used to select the elements to display in the displayed line of full usage information.
setGroup(Group) - Method in class org.apache.commons.cli2.commandline.Parser
Sets the Group of options to parse against
setGroup(Group) - Method in class org.apache.commons.cli2.util.HelpFormatter
Sets the Group of Options to document
setHeader(String) - Method in class org.apache.commons.cli2.util.HelpFormatter
Sets the footer text of the help screen
setHelpFormatter(HelpFormatter) - Method in class org.apache.commons.cli2.commandline.Parser
Sets the HelpFormatter to use with the simplified parsing.
setHelpOption(Option) - Method in class org.apache.commons.cli2.commandline.Parser
Sets the help option to use with the simplified parsing.
setHelpTrigger(String) - Method in class org.apache.commons.cli2.commandline.Parser
Sets the help option to use with the simplified parsing.
setHidden(boolean) - Method in class org.apache.commons.cli2.validation.FileValidator
Specifies whether the argument values must represent hidden files/directories.
setInstance(boolean) - Method in class org.apache.commons.cli2.validation.ClassValidator
Specifies whether the argument value must represent a class that can be instantiated.
setLenient(boolean) - Method in class org.apache.commons.cli2.validation.DateValidator
Sets whether this validator uses lenient parsing.
setLineUsageSettings(Set) - Method in class org.apache.commons.cli2.util.HelpFormatter
Sets the DisplaySettings used to select elements in the per helpline usage strings.
setLoadable(boolean) - Method in class org.apache.commons.cli2.validation.ClassValidator
Specifies whether the argument value must represent a class that is loadable.
setMaximum(Date) - Method in class org.apache.commons.cli2.validation.DateValidator
Sets the maximum Date to the specified value.
setMaximum(Number) - Method in class org.apache.commons.cli2.validation.NumberValidator
Specify the maximum value allowed for an argument value.
setMinimum(Date) - Method in class org.apache.commons.cli2.validation.DateValidator
Sets the minimum Date to the specified value.
setMinimum(Number) - Method in class org.apache.commons.cli2.validation.NumberValidator
Specify the minimum value allowed for an argument value.
setPrintWriter(PrintWriter) - Method in class org.apache.commons.cli2.util.HelpFormatter
 
setProtocol(String) - Method in class org.apache.commons.cli2.validation.UrlValidator
Specifies the protocol that a URL must have to be valid.
setReadable(boolean) - Method in class org.apache.commons.cli2.validation.FileValidator
Specifies whether the argument values must represent readable files/directories.
setShellCommand(String) - Method in class org.apache.commons.cli2.util.HelpFormatter
Sets the command string used to invoke the application
setValidValues(Set) - Method in class org.apache.commons.cli2.validation.EnumValidator
Specifies the Set of valid argument values.
setWritable(boolean) - Method in class org.apache.commons.cli2.validation.FileValidator
Specifies whether the argument values must represent writable files/directories.
shellCommand - Variable in class org.apache.commons.cli2.util.HelpFormatter
 
shortPrefix - Variable in class org.apache.commons.cli2.builder.DefaultOptionBuilder
 
shortPrefix - Variable in class org.apache.commons.cli2.option.DefaultOption
 
source - Variable in class org.apache.commons.cli2.option.SourceDestArgument
 
SOURCE_DEST_MUST_ENFORCE_VALUES - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SourceDestArgument - Class in org.apache.commons.cli2.option
An Argument implementation that allows a variable size Argument to precede a fixed size argument.
SourceDestArgument(Argument, Argument) - Constructor for class org.apache.commons.cli2.option.SourceDestArgument
Creates a SourceDestArgument using defaults where possible.
SourceDestArgument(Argument, Argument, char, char, String, List) - Constructor for class org.apache.commons.cli2.option.SourceDestArgument
Creates a SourceDestArgument using the specified parameters.
stripBoundaryQuotes(String) - Method in class org.apache.commons.cli2.option.ArgumentImpl
If there are any leading or trailing quotes remove them from the specified token.
subsequentSeparator - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
character used to separate the values from each other
subsequentSeparator - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
subsequentSplit - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
sum(int, int) - Static method in class org.apache.commons.cli2.option.SourceDestArgument
 
Switch - Class in org.apache.commons.cli2.option
A Parent implementation representing normal switch options.
Switch(String, String, String, Set, String, boolean, Argument, Group, int, Boolean) - Constructor for class org.apache.commons.cli2.option.Switch
Creates a new Switch with the specified parameters
SWITCH_ALREADY_SET - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SWITCH_DISABLED_STARTWS_WITH_ENABLED - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SWITCH_ENABLED_STARTS_WITH_DISABLED - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SWITCH_IDENTICAL_PREFIXES - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SWITCH_ILLEGAL_DISABLED_PREFIX - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SWITCH_ILLEGAL_ENABLED_PREFIX - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SWITCH_NO_DISABLED_PREFIX - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SWITCH_NO_ENABLED_PREFIX - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SWITCH_PREFERRED_NAME_TOO_SHORT - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
SwitchBuilder - Class in org.apache.commons.cli2.builder
Builds Switch instance.
SwitchBuilder() - Constructor for class org.apache.commons.cli2.builder.SwitchBuilder
Creates a new SwitchBuilder using defaults.
SwitchBuilder(String, String) - Constructor for class org.apache.commons.cli2.builder.SwitchBuilder
Creates a new SwitchBuilder
switchDefault - Variable in class org.apache.commons.cli2.builder.SwitchBuilder
 
switches - Variable in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
switchFirst() - Static method in class org.apache.commons.cli2.util.Comparators
Forces Switch instances to appear at the beginning of lists
switchLast() - Static method in class org.apache.commons.cli2.util.Comparators
Forces Switch instances to appear at the end of lists

T

toString() - Method in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 
toString() - Method in class org.apache.commons.cli2.DisplaySetting
 
toString() - Method in class org.apache.commons.cli2.option.OptionImpl
 
triggers - Variable in class org.apache.commons.cli2.option.Command
All the names for this command
triggers - Variable in class org.apache.commons.cli2.option.DefaultOption
 
triggers - Variable in class org.apache.commons.cli2.option.Switch
 

U

UNEXPECTED_TOKEN - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
UrlValidator - Class in org.apache.commons.cli2.validation
The UrlValidator validates the string argument values are URLs.
UrlValidator() - Constructor for class org.apache.commons.cli2.validation.UrlValidator
Creates a UrlValidator.
UrlValidator(String) - Constructor for class org.apache.commons.cli2.validation.UrlValidator
Creates a UrlValidator for the specified protocol.
URLVALIDATOR_MALFORMED_URL - Static variable in class org.apache.commons.cli2.resource.ResourceConstants
 
usage(Set, Comparator) - Method in interface org.apache.commons.cli2.HelpLine
Builds a usage string for the option using the specified settings and comparator.
usage(Set, Comparator) - Method in class org.apache.commons.cli2.option.HelpLineImpl
Builds a usage string for the option using the specified settings and comparator.

V

validate(WriteableCommandLine, Option) - Method in interface org.apache.commons.cli2.Argument
Performs any necessary validation on the values added to the CommandLine.
validate(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
validate(WriteableCommandLine, Option) - Method in class org.apache.commons.cli2.option.ArgumentImpl
 
validate(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.Command
 
validate(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.DefaultOption
 
validate(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.GroupImpl
 
validate(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.ParentImpl
 
validate(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.PropertyOption
 
validate(WriteableCommandLine, Option) - Method in class org.apache.commons.cli2.option.SourceDestArgument
 
validate(WriteableCommandLine) - Method in class org.apache.commons.cli2.option.Switch
 
validate(WriteableCommandLine) - Method in interface org.apache.commons.cli2.Option
Checks that the supplied CommandLine is valid with respect to this option.
validate(List) - Method in class org.apache.commons.cli2.validation.ClassValidator
Validate each argument value in the specified List against this instances permitted attributes.
validate(List) - Method in class org.apache.commons.cli2.validation.DateValidator
Validate each String value in the specified List against this instances permitted DateFormats.
validate(List) - Method in class org.apache.commons.cli2.validation.EnumValidator
Validate the list of values against the list of permitted values.
validate(List) - Method in class org.apache.commons.cli2.validation.FileValidator
Validate the list of values against the list of permitted values.
validate(List) - Method in class org.apache.commons.cli2.validation.NumberValidator
Validate the list of values against the list of permitted values.
validate(List) - Method in class org.apache.commons.cli2.validation.UrlValidator
Validate the list of values against the list of permitted values.
validate(List) - Method in interface org.apache.commons.cli2.validation.Validator
Validate the specified values (List of Strings).
validator - Variable in class org.apache.commons.cli2.builder.ArgumentBuilder
object that should be used to ensure the values are valid
validator(char) - Static method in class org.apache.commons.cli2.builder.PatternBuilder
 
validator - Variable in class org.apache.commons.cli2.option.ArgumentImpl
 
Validator - Interface in org.apache.commons.cli2.validation
The validation interface for validating argument values(s).
validValues - Variable in class org.apache.commons.cli2.validation.EnumValidator
List of permitted values
values - Variable in class org.apache.commons.cli2.commandline.WriteableCommandLineImpl
 

W

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

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