Index (JCLAP 1.2 API)

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

A

accept(String) - Method in class snaq.util.jclap.StringOption.FileFilter: Determines whether the string argument is valid as an option value.
accept(String) - Method in interface snaq.util.jclap.StringOption.Filter: Determines whether the specified argument should be accepted for use by the host StringOption instance.
addBooleanOption(String, String, String, int, int) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Boolean.
addBooleanOption(String, String, String, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Boolean.
addBooleanOption(String, String, String) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Boolean (single value allowed).
addBooleanOption(String, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Boolean.
addBooleanOption(String) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Boolean (single value allowed).
addDoubleOption(String, String, String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Double.
addDoubleOption(String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Double.
addEnumIntegerOption(String, String, String, boolean, boolean, int[]) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of enumerated Integer type.
addEnumIntegerOption(String, String, String, int[]) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of enumerated Integer type (single value allowed, non-mandatory).
addEnumStringOption(String, String, String, boolean, boolean, String[], boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of enumerated String type.
addEnumStringOption(String, String, String, boolean, boolean, String[]) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of enumerated String type (case-insensitive string matching).
addEnumStringOption(String, String, String, String[]) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of enumerated String type (single value allowed, non-mandatory).
addFileExistingOption(String, String, String, int, int) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type String which refers to an existing file (which is not a folder).
addFileExistingOption(String, String, String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type String which refers to an existing file (which is not a folder).
addFileNewOption(String, String, String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type String which refers to a new or existing file/folder.
addFileOption(String, String, String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type String which refers to a file/folder.
addFloatOption(String, String, String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Float.
addFloatOption(String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Float.
addFolderExistingOption(String, String, String, int, int) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type String which refers to an existing folder.
addFolderExistingOption(String, String, String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type String which refers to an existing folder.
addIntegerOption(String, String, String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Integer.
addIntegerOption(String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Integer.
addLongOption(String, String, String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Long.
addLongOption(String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type Long.
addOption(Option<T>) - Method in class snaq.util.jclap.CLAParser: Adds the specified Option to the list of those to be parsed from the command-line arguments.
addStringOption(String, String, String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type String.
addStringOption(String, String, String) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type String (single value allowed, non-mandatory).
addStringOption(String, boolean, boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to add an Option of type String (no long name, no description).
addValue(E) - Method in class snaq.util.jclap.Option: Adds the specified value to the list of those parsed.
allowedValues - Variable in class snaq.util.jclap.EnumeratedOption: Collection of allowed values for this enumeration.

B

baseBundle - Static variable in exception snaq.util.jclap.OptionException: Resources for internationalisation (for base locale).
BooleanOption - Class in snaq.util.jclap: Implementation of an Option with value of type Boolean (otherwise known as a "flag").
BooleanOption(String, String, String, int, int) - Constructor for class snaq.util.jclap.BooleanOption: Creates a new BooleanOption instance.
BooleanOption(String, String, String, boolean) - Constructor for class snaq.util.jclap.BooleanOption: Creates a new BooleanOption instance.
bundle - Static variable in class snaq.util.jclap.Option: Resources for internationalization.
bundle - Static variable in exception snaq.util.jclap.OptionException: Resources for internationalization.

C

CLAParser - Class in snaq.util.jclap: Utility class to provide support for command-line options parsing.
CLAParser() - Constructor for class snaq.util.jclap.CLAParser: Creates a new CLAParser instance, using the default locale.

D

DateOption - Class in snaq.util.jclap: Option implementation for specifying date values.
DateOption(String, String, String, boolean, boolean, boolean) - Constructor for class snaq.util.jclap.DateOption
DateOption(String, String, String, boolean, int, int) - Constructor for class snaq.util.jclap.DateOption
DoubleOption - Class in snaq.util.jclap: Implementation of an Option with value of type Double.
DoubleOption(String, String, String, int, int) - Constructor for class snaq.util.jclap.DoubleOption: Creates a new DoubleOption instance.
DoubleOption(String, String, String, boolean, boolean) - Constructor for class snaq.util.jclap.DoubleOption: Creates a new DoubleOption instance.

E

EnumeratedIntegerOption - Class in snaq.util.jclap: Implementation of an Option with value restricted to a specified enumeration of type Integer.
EnumeratedIntegerOption(String, String, String, int, int, Collection<Integer>) - Constructor for class snaq.util.jclap.EnumeratedIntegerOption: Creates a new EnumeratedIntegerOption instance.
EnumeratedIntegerOption(String, String, String, boolean, boolean, Collection<Integer>) - Constructor for class snaq.util.jclap.EnumeratedIntegerOption: Creates a new EnumeratedIntegerOption instance.
EnumeratedOption<E> - Class in snaq.util.jclap: Implementation of an Option with value restricted to an enumeration of a specified return value type.
EnumeratedOption(String, String, String, int, int, Collection<E>) - Constructor for class snaq.util.jclap.EnumeratedOption: Creates a new EnumeratedOption instance.
EnumeratedOption(String, String, String, boolean, boolean, Collection<E>) - Constructor for class snaq.util.jclap.EnumeratedOption: Creates a new EnumeratedOption instance.
EnumeratedStringOption - Class in snaq.util.jclap: Implementation of an Option with value restricted to a specified enumeration of type String.
EnumeratedStringOption(String, String, String, int, int, Collection<String>, boolean) - Constructor for class snaq.util.jclap.EnumeratedStringOption: Creates a new EnumeratedStringOption instance.
EnumeratedStringOption(String, String, String, boolean, boolean, Collection<String>, boolean) - Constructor for class snaq.util.jclap.EnumeratedStringOption: Creates a new EnumeratedStringOption instance.
equals(Object) - Method in class snaq.util.jclap.Option

F

FloatOption - Class in snaq.util.jclap: Implementation of an Option with value of type Float.
FloatOption(String, String, String, int, int) - Constructor for class snaq.util.jclap.FloatOption: Creates a new FloatOption instance.
FloatOption(String, String, String, boolean, boolean) - Constructor for class snaq.util.jclap.FloatOption: Creates a new FloatOption instance.

G

getAllowedValues() - Method in class snaq.util.jclap.EnumeratedOption: Returns an unmodifiable collection of the values that can be assigned to this option.
getAllowedValuesString(String, String, String) - Method in class snaq.util.jclap.EnumeratedOption: Returns a string denoting the values that can be assigned to this option.
getAllowedValuesString(String, String) - Method in class snaq.util.jclap.EnumeratedOption: Returns a string denoting the values that can be assigned to this option.
getAllowedValuesString() - Method in class snaq.util.jclap.EnumeratedOption
getAllowedValuesString() - Method in class snaq.util.jclap.EnumeratedStringOption: Returns the default version of the string denoting the values that can be assigned to this option ()
getBooleanOptionValue(String, Boolean) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getBooleanOptionValue(String) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or false if the option was not set.
getBooleanOptionValues(String) - Method in class snaq.util.jclap.CLAParser: Returns a list of all the parsed values for the specified option, or an empty list if the option was not set.
getDateFormat() - Method in class snaq.util.jclap.DateOption
getDescription() - Method in class snaq.util.jclap.Option: Returns the description text of this Option.
getDoubleOptionValue(String, Double) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getDoubleOptionValue(String) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getDoubleOptionValues(String) - Method in class snaq.util.jclap.CLAParser: Returns a list of all the parsed values for the specified option, or an empty list if the option was not set.
getFilter() - Method in class snaq.util.jclap.StringOption: Returns the StringOption.Filter for this instance.
getFloatOptionValue(String, Float) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getFloatOptionValue(String) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getFloatOptionValues(String) - Method in class snaq.util.jclap.CLAParser: Returns a list of all the parsed values for the specified option, or an empty list if the option was not set.
getIntegerOptionValue(String, Integer) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getIntegerOptionValue(String) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getIntegerOptionValues(String) - Method in class snaq.util.jclap.CLAParser: Returns a list of all the parsed values for the specified option, or an empty list if the option was not set.
getLocalizedMessage() - Method in exception snaq.util.jclap.OptionException
getLongName() - Method in class snaq.util.jclap.Option: Returns the long name of this option.
getLongOptionValue(String, Long) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getLongOptionValue(String) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getLongOptionValues(String) - Method in class snaq.util.jclap.CLAParser: Returns a list of all the parsed values for the specified option, or an empty list if the option was not set.
getMaxCount() - Method in class snaq.util.jclap.Option: Returns the maximum value count for this option.
getMessage() - Method in exception snaq.util.jclap.OptionException
getMinCount() - Method in class snaq.util.jclap.Option: Returns the minimum value count for this option.
getNonOptionArguments() - Method in class snaq.util.jclap.CLAParser: Returns a list of the non-option command-line arguments.
getOption(String, Class<T>) - Method in class snaq.util.jclap.CLAParser: Returns the Option with the specified name (either short or long).
getOptions() - Method in class snaq.util.jclap.CLAParser: Returns all the Option instances registered with the parser.
getOptionValue(Option<T>) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the specified option, or null if the option was not set.
getOptionValue(Option<T>, T) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the specified option, or the specified default value if the option was not set.
getOptionValue(String, Class<T>, T) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getOptionValue(String, Class<T>) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or null if the option was not set, equivalent to getOptionValue(optionName, type, null).
getOptionValues(Option<T>) - Method in class snaq.util.jclap.CLAParser: Returns a list of all the parsed values for the specified option, or an empty list if the option was not set.
getOptionValues(String, Class<T>) - Method in class snaq.util.jclap.CLAParser: Returns a list of all the parsed values for the specified option, or an empty list if the option was not set.
getShortName() - Method in class snaq.util.jclap.Option: Returns the short name of this option.
getStringOptionValue(String, String) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getStringOptionValue(String) - Method in class snaq.util.jclap.CLAParser: Convenience method to return the parsed value of the named option, or the specified default value if the option was not set.
getStringOptionValues(String) - Method in class snaq.util.jclap.CLAParser: Returns a list of all the parsed values for the specified option, or an empty list if the option was not set.
getType() - Method in class snaq.util.jclap.BooleanOption
getType() - Method in class snaq.util.jclap.DateOption
getType() - Method in class snaq.util.jclap.DoubleOption
getType() - Method in class snaq.util.jclap.EnumeratedIntegerOption
getType() - Method in class snaq.util.jclap.EnumeratedStringOption
getType() - Method in class snaq.util.jclap.FloatOption
getType() - Method in class snaq.util.jclap.IntegerOption
getType() - Method in class snaq.util.jclap.LongOption
getType() - Method in class snaq.util.jclap.Option: Returns the class type of value this option can take.
getType() - Method in exception snaq.util.jclap.OptionException: Returns the type of this OptionException.
getType() - Method in class snaq.util.jclap.StringOption
getUsageTypeString() - Method in class snaq.util.jclap.BooleanOption
getUsageTypeString() - Method in class snaq.util.jclap.DoubleOption
getUsageTypeString() - Method in class snaq.util.jclap.FloatOption
getUsageTypeString() - Method in class snaq.util.jclap.IntegerOption
getUsageTypeString() - Method in class snaq.util.jclap.LongOption
getUsageTypeString() - Method in class snaq.util.jclap.Option: Returns the option type, for display in the usage message.
getValues() - Method in class snaq.util.jclap.Option: Returns the mapped value of the specified argument if it exists.

H

hashCode() - Method in class snaq.util.jclap.Option

I

ILLEGAL_SN_CHARS - Static variable in class snaq.util.jclap.Option: String denoting illegal characters for short name.
IntegerOption - Class in snaq.util.jclap: Implementation of an Option with value of type Integer.
IntegerOption(String, String, String, int, int) - Constructor for class snaq.util.jclap.IntegerOption: Creates a new IntegerOption instance.
IntegerOption(String, String, String, boolean, boolean) - Constructor for class snaq.util.jclap.IntegerOption: Creates a new IntegerOption instance.
isAllowMany() - Method in class snaq.util.jclap.Option: Returns whether this option allows multiple values to be set.
isHidden() - Method in class snaq.util.jclap.Option: Returns whether this option is hidden from the usage message.
isMandatory() - Method in class snaq.util.jclap.Option: Returns whether this option is mandatory.
isValueValid(E) - Method in class snaq.util.jclap.EnumeratedOption

L

locale - Static variable in class snaq.util.jclap.Option: Locale for help/error display.
locale - Static variable in exception snaq.util.jclap.OptionException: Locale for help/error display.
LongOption - Class in snaq.util.jclap: Implementation of an Option with value of type Long.
LongOption(String, String, String, int, int) - Constructor for class snaq.util.jclap.LongOption: Creates a new LongOption instance.
LongOption(String, String, String, boolean, boolean) - Constructor for class snaq.util.jclap.LongOption: Creates a new LongOption instance.

M

main(String[]) - Static method in class snaq.util.jclap.DateOption
main(String[]) - Static method in class snaq.util.jclap.example.ParserExample
MAX_COUNT_LIMIT - Static variable in class snaq.util.jclap.Option: Limit to maximum number of occurrences required for this option (set to an arbitrary 100).
MIN_COUNT_LIMIT - Static variable in class snaq.util.jclap.Option: Limit to minimum number of occurrences required for this option.

O

Option<E> - Class in snaq.util.jclap: Base implementation of a command-line option.
Option(String, String, String, boolean, int, int) - Constructor for class snaq.util.jclap.Option: Creates a new Option instance.
Option(String, String, String, boolean, boolean, boolean) - Constructor for class snaq.util.jclap.Option: Creates a new Option instance.
OptionException - Exception in snaq.util.jclap: Exception for command-line option parsing problems.
OptionException(OptionException.Type, Option, String) - Constructor for exception snaq.util.jclap.OptionException: Creates a new OptionException instance.
OptionException(OptionException.Type, String, String) - Constructor for exception snaq.util.jclap.OptionException: Creates a new OptionException instance.
OptionException(OptionException.Type, String, char) - Constructor for exception snaq.util.jclap.OptionException: Creates a new OptionException instance.
OptionException(OptionException.Type, Option) - Constructor for exception snaq.util.jclap.OptionException: Creates a new OptionException instance.
OptionException(OptionException.Type, String) - Constructor for exception snaq.util.jclap.OptionException: Creates a new OptionException instance.
OptionException.Type - Enum in snaq.util.jclap: Defines the types of OptionException that exist.

P

parse(String[]) - Method in class snaq.util.jclap.CLAParser: Extract the option-mapped and unmapped arguments from the given array of command-line arguments, using the specified locale.
parsedSolitaryHyphen() - Method in class snaq.util.jclap.CLAParser: Returns whether a single - argument was found.
parseOrig(String[]) - Method in class snaq.util.jclap.CLAParser: Extract the option-mapped and unmapped arguments from the given array of command-line arguments, using the specified locale.
ParserExample - Class in snaq.util.jclap.example: Example usage of CLAParser class, showing how options may be added, parsed, and referenced, along with a recommended exception-handling strategy.
ParserExample() - Constructor for class snaq.util.jclap.example.ParserExample
parseValue(String) - Method in class snaq.util.jclap.BooleanOption: Parsing of a flag option makes little sense.
parseValue(String) - Method in class snaq.util.jclap.DateOption
parseValue(String) - Method in class snaq.util.jclap.DoubleOption: Parses the argument string for an option value.
parseValue(String) - Method in class snaq.util.jclap.EnumeratedIntegerOption: Parses the argument string for an option value.
parseValue(String) - Method in class snaq.util.jclap.EnumeratedStringOption: Parses the argument string for an option value.
parseValue(String) - Method in class snaq.util.jclap.FloatOption: Parses the argument string for an option value.
parseValue(String) - Method in class snaq.util.jclap.IntegerOption: Parses the argument string for an option value.
parseValue(String) - Method in class snaq.util.jclap.LongOption: Parses the argument string for an option value.
parseValue(String) - Method in class snaq.util.jclap.Option: Parses the argument string for an option value.
parseValue(String) - Method in class snaq.util.jclap.StringOption
printUsage(PrintStream, boolean) - Method in class snaq.util.jclap.CLAParser: Prints the command-line usage message to the specified PrintStream, making a guess at the application launch command.
printUsage(PrintStream, boolean, String) - Method in class snaq.util.jclap.CLAParser: Prints the command-line usage message to the specified PrintStream.
printUsage(PrintStream, boolean, String, String) - Method in class snaq.util.jclap.CLAParser: Prints the command-line usage message to the specified PrintStream.

R

requiresValue() - Method in class snaq.util.jclap.Option: Returns whether this option requires a value.

S

setFilter(StringOption.Filter) - Method in class snaq.util.jclap.StringOption: Sets the StringOption.Filter for this instance.
setHidden(String) - Method in class snaq.util.jclap.CLAParser: Hides the specified Option from being printed in the usage message.
setHidden() - Method in class snaq.util.jclap.Option: Sets the flag to hide this option from the usage message.
setMinMaxCounts(int, int) - Method in class snaq.util.jclap.Option: Sets the minimum/maximum value counts for this option.
sFalse - Static variable in class snaq.util.jclap.BooleanOption
snaq.util.jclap - package snaq.util.jclap: Library for parsing command-line arguments in Java applications.
snaq.util.jclap.example - package snaq.util.jclap.example: Example application for demonstrating use of JCLAP library.
StringOption - Class in snaq.util.jclap: Implementation of an Option with value of type String.
StringOption(String, String, String, int, int) - Constructor for class snaq.util.jclap.StringOption: Creates a new StringOption instance.
StringOption(String, String, String, boolean, boolean) - Constructor for class snaq.util.jclap.StringOption: Creates a new StringOption instance.
StringOption.FileFilter - Class in snaq.util.jclap: Implementation of an StringOption.Filter which filters based on existence and type of file to which the string refers.
StringOption.FileFilter(StringOption.FileFilter.AcceptExistance, StringOption.FileFilter.AcceptFileType) - Constructor for class snaq.util.jclap.StringOption.FileFilter: Creates a new FileOption instance (allows files/folders).
StringOption.FileFilter.AcceptExistance - Enum in snaq.util.jclap: Enumeration of possible file existence states to accept.
StringOption.FileFilter.AcceptFileType - Enum in snaq.util.jclap: Enumeration of possible types to accept.
StringOption.Filter - Interface in snaq.util.jclap: Acceptance filter for StringOption instances.
sTrue - Static variable in class snaq.util.jclap.BooleanOption

T

toString() - Method in class snaq.util.jclap.EnumeratedOption
toString() - Method in class snaq.util.jclap.Option

V

valueOf(String) - Static method in enum snaq.util.jclap.OptionException.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum snaq.util.jclap.StringOption.FileFilter.AcceptExistance: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum snaq.util.jclap.StringOption.FileFilter.AcceptFileType: Returns the enum constant of this type with the specified name.
values - Variable in class snaq.util.jclap.Option: List of values for this option.
values() - Static method in enum snaq.util.jclap.OptionException.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum snaq.util.jclap.StringOption.FileFilter.AcceptExistance: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum snaq.util.jclap.StringOption.FileFilter.AcceptFileType: Returns an array containing the constants of this enum type, in the order they are declared.

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