Index (JOpt Simple 6.0-alpha-3 API)

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

A

AbstractOptionSpec<V> - Class in joptsimple
accepts(String) - Method in interface joptsimple.OptionDeclarer: Tells the parser to recognize the given option.
accepts(String, String) - Method in interface joptsimple.OptionDeclarer: Tells the parser to recognize the given option.
accepts(String) - Method in class joptsimple.OptionParser
accepts(String, String) - Method in class joptsimple.OptionParser
acceptsAll(List<String>) - Method in interface joptsimple.OptionDeclarer: Tells the parser to recognize the given options, and treat them as synonymous.
acceptsAll(List<String>, String) - Method in interface joptsimple.OptionDeclarer: Tells the parser to recognize the given options, and treat them as synonymous.
acceptsAll(List<String>) - Method in class joptsimple.OptionParser
acceptsAll(List<String>, String) - Method in class joptsimple.OptionParser
acceptsArguments() - Method in class joptsimple.ArgumentAcceptingOptionSpec
acceptsArguments() - Method in class joptsimple.NonOptionArgumentSpec
acceptsArguments() - Method in interface joptsimple.OptionDescriptor: Does this option accept arguments?
allowsUnrecognizedOptions() - Method in interface joptsimple.OptionDeclarer: Tells the parser to treat unrecognized options as non-option arguments.
allowsUnrecognizedOptions() - Method in class joptsimple.OptionParser
ArgumentAcceptingOptionSpec<V> - Class in joptsimple: Specification of an option that accepts an argument.
argumentConverter() - Method in class joptsimple.ArgumentAcceptingOptionSpec
argumentConverter() - Method in class joptsimple.NonOptionArgumentSpec
argumentConverter() - Method in interface joptsimple.OptionDescriptor: Gives an object that can convert raw string values into objects of the type of this option's argument
argumentDescription() - Method in class joptsimple.ArgumentAcceptingOptionSpec
argumentDescription() - Method in class joptsimple.NonOptionArgumentSpec
argumentDescription() - Method in interface joptsimple.OptionDescriptor: Gives a short description of the option's argument.
argumentTypeIndicator() - Method in class joptsimple.ArgumentAcceptingOptionSpec
argumentTypeIndicator() - Method in class joptsimple.NonOptionArgumentSpec
argumentTypeIndicator() - Method in interface joptsimple.OptionDescriptor: Gives an indication of the expected type of the option's argument.
asMap() - Method in class joptsimple.OptionSet: Gives all declared options as a map of string to OptionSpec.
availableIf(String, String...) - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option is allowed if the given option is present on the command line.
availableIf(OptionSpec<?>, OptionSpec<?>...) - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option is allowed if the given option is present on the command line.
availableUnless(String, String...) - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option is allowed if the given option is absent on the command line.
availableUnless(OptionSpec<?>, OptionSpec<?>...) - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option is allowed if the given option is absent on the command line.

B

BuiltinHelpFormatter - Class in joptsimple: A help formatter that allows configuration of overall row width and column separator width.
BuiltinHelpFormatter(int, int) - Constructor for class joptsimple.BuiltinHelpFormatter: Makes a formatter with a given overall row width and column separator width.

C

convert(String) - Method in class joptsimple.util.DateConverter
convert(String) - Method in class joptsimple.util.EnumConverter
convert(String) - Method in class joptsimple.util.InetAddressConverter
convert(String) - Method in class joptsimple.util.PathConverter
convert(String) - Method in class joptsimple.util.RegexMatcher
convert(String) - Method in interface joptsimple.ValueConverter: Converts the given string value into a Java type.

D

DateConverter - Class in joptsimple.util: Converts values to Dates using a DateFormat object.
DateConverter(DateFormat) - Constructor for class joptsimple.util.DateConverter: Creates a converter that uses the given date formatter/parser.
datePattern(String) - Static method in class joptsimple.util.DateConverter: Creates a converter that uses a SimpleDateFormat with the given date/time pattern.
defaultsTo(V, V...) - Method in class joptsimple.ArgumentAcceptingOptionSpec: Specifies a set of default values for the argument of the option that this spec represents.
defaultsTo(V[]) - Method in class joptsimple.ArgumentAcceptingOptionSpec: Specifies a set of default values for the argument of the option that this spec represents.
defaultValues() - Method in class joptsimple.ArgumentAcceptingOptionSpec
defaultValues() - Method in class joptsimple.NonOptionArgumentSpec
defaultValues() - Method in interface joptsimple.OptionDescriptor: What values will the option take if none are specified on the command line?
describedAs(String) - Method in class joptsimple.ArgumentAcceptingOptionSpec: Specifies a description for the argument of the option that this spec represents.
describedAs(String) - Method in class joptsimple.NonOptionArgumentSpec: Specifies a description for the non-option arguments that this spec represents.
description() - Method in class joptsimple.AbstractOptionSpec
description() - Method in interface joptsimple.OptionDescriptor: Description of this option's purpose.

E

EnumConverter<E extends Enum<E>> - Class in joptsimple.util: Converts values to Enums.
equals(Object) - Method in class joptsimple.AbstractOptionSpec
equals(Object) - Method in class joptsimple.ArgumentAcceptingOptionSpec
equals(Object) - Method in class joptsimple.OptionSet
equals(Object) - Method in class joptsimple.util.KeyValuePair

F

forHelp() - Method in class joptsimple.AbstractOptionSpec
format(Map<String, ? extends OptionDescriptor>) - Method in class joptsimple.BuiltinHelpFormatter: Produces help text, given a set of option descriptors.
format(Map<String, ? extends OptionDescriptor>) - Method in interface joptsimple.HelpFormatter: Produces help text, given a set of option descriptors.
formatHelpWith(HelpFormatter) - Method in class joptsimple.OptionParser: Tells the parser to use the given formatter when asked to print help.

G

getMessage() - Method in exception joptsimple.OptionException

H

has(String) - Method in class joptsimple.OptionSet: Tells whether the given option was detected.
has(OptionSpec<?>) - Method in class joptsimple.OptionSet: Tells whether the given option was detected.
hasArgument(String) - Method in class joptsimple.OptionSet: Tells whether there are any arguments associated with the given option.
hasArgument(OptionSpec<?>) - Method in class joptsimple.OptionSet: Tells whether there are any arguments associated with the given option.
hashCode() - Method in class joptsimple.AbstractOptionSpec
hashCode() - Method in class joptsimple.ArgumentAcceptingOptionSpec
hashCode() - Method in class joptsimple.OptionSet
hashCode() - Method in class joptsimple.util.KeyValuePair
hasOptions() - Method in class joptsimple.OptionSet: Tells whether any options were detected.
HelpFormatter - Interface in joptsimple: Represents objects charged with taking a set of option descriptions and producing some help text from them.

I

InetAddressConverter - Class in joptsimple.util: Converts values to InetAddress using getByName.
InetAddressConverter() - Constructor for class joptsimple.util.InetAddressConverter
isForHelp() - Method in class joptsimple.AbstractOptionSpec
isForHelp() - Method in interface joptsimple.OptionSpec: Tells whether this option is designated as a "help" option.
isRequired() - Method in class joptsimple.ArgumentAcceptingOptionSpec
isRequired() - Method in class joptsimple.NonOptionArgumentSpec
isRequired() - Method in interface joptsimple.OptionDescriptor: Is this option required on a command line?

J

joptsimple - package joptsimple
joptsimple.util - package joptsimple.util

K

key - Variable in class joptsimple.util.KeyValuePair
KeyValuePair - Class in joptsimple.util: A simple string key/string value pair.

M

mutuallyExclusive(OptionSpecBuilder...) - Method in class joptsimple.OptionParser: Mandates mutual exclusiveness for the options built by the specified builders.

N

nonOptionArguments() - Method in class joptsimple.OptionSet
NonOptionArgumentSpec<V> - Class in joptsimple: Specification of a command line's non-option arguments.
nonOptions() - Method in interface joptsimple.OptionDeclarer: Gives an object that represents an access point for non-option arguments on a command line.
nonOptions(String) - Method in interface joptsimple.OptionDeclarer: Gives an object that represents an access point for non-option arguments on a command line.
nonOptions() - Method in class joptsimple.OptionParser
nonOptions(String) - Method in class joptsimple.OptionParser

O

ofType(Class<T>) - Method in class joptsimple.ArgumentAcceptingOptionSpec: Specifies a type to which arguments of this spec's option are to be converted.
ofType(Class<T>) - Method in class joptsimple.NonOptionArgumentSpec: Specifies a type to which the non-option arguments are to be converted.
OptionDeclarer - Interface in joptsimple: Trains the option parser.
OptionDescriptor - Interface in joptsimple: Describes options that an option parser recognizes, in ways that might be useful to help screens.
OptionException - Exception in joptsimple: Thrown when a problem occurs during option parsing.
OptionParser - Class in joptsimple: Parses command line arguments, using a syntax that attempts to take from the best of POSIX getopt() and GNU getopt_long().
OptionParser() - Constructor for class joptsimple.OptionParser: Creates an option parser that initially recognizes no options, and does not exhibit "POSIX-ly correct" behavior.
OptionParser(boolean) - Constructor for class joptsimple.OptionParser: Creates an option parser that initially recognizes no options, and does not exhibit "POSIX-ly correct" behavior.
OptionParser(String) - Constructor for class joptsimple.OptionParser: Creates an option parser and configures it to recognize the short options specified in the given string.
options() - Method in class joptsimple.AbstractOptionSpec
options() - Method in interface joptsimple.OptionDescriptor: A set of options that are mutually synonymous.
options() - Method in exception joptsimple.OptionException: Gives the option being considered when the exception was created.
options() - Method in interface joptsimple.OptionSpec
OptionSet - Class in joptsimple: Representation of a group of detected command line options, their arguments, and non-option arguments.
OptionSpec<V> - Interface in joptsimple: Describes options that an option parser recognizes.
OptionSpecBuilder - Class in joptsimple: Allows callers to specify whether a given option accepts arguments (required or optional).

P

parse(String...) - Method in class joptsimple.OptionParser: Parses the given command line arguments according to the option specifications given to the parser.
PathConverter - Class in joptsimple.util: Converts command line options to Path objects and checks the status of the underlying file.
PathConverter(PathProperties...) - Constructor for class joptsimple.util.PathConverter
PathProperties - Enum in joptsimple.util: Enum for checking common conditions of files and directories.
posixlyCorrect(boolean) - Method in interface joptsimple.OptionDeclarer: Tells the parser whether or not to behave "POSIX-ly correct"-ly.
posixlyCorrect(boolean) - Method in class joptsimple.OptionParser
printHelpOn(OutputStream) - Method in class joptsimple.OptionParser: Writes information about the options this parser recognizes to the given output sink.
printHelpOn(Writer) - Method in class joptsimple.OptionParser: Writes information about the options this parser recognizes to the given output sink.

R

recognizeAlternativeLongOptions(boolean) - Method in interface joptsimple.OptionDeclarer: Tells the parser either to recognize or ignore -W-style long options.
recognizeAlternativeLongOptions(boolean) - Method in class joptsimple.OptionParser
recognizedOptions() - Method in class joptsimple.OptionParser: Retrieves all options-spec pairings which have been configured for the parser in the same order as declared during training.
regex(String) - Static method in class joptsimple.util.RegexMatcher: Gives a matcher that uses the given regular expression.
RegexMatcher - Class in joptsimple.util: Ensures that values entirely match a regular expression.
RegexMatcher(String, int) - Constructor for class joptsimple.util.RegexMatcher: Creates a matcher that uses the given regular expression, modified by the given flags.
representsNonOptions() - Method in class joptsimple.AbstractOptionSpec
representsNonOptions() - Method in class joptsimple.NonOptionArgumentSpec
representsNonOptions() - Method in interface joptsimple.OptionDescriptor: Tells whether this object represents the non-option arguments of a command line.
required() - Method in class joptsimple.ArgumentAcceptingOptionSpec: Marks this option as required.
requiredIf(String, String...) - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option is required if the given option is present on the command line.
requiredIf(OptionSpec<?>, OptionSpec<?>...) - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option is required if the given option is present on the command line.
requiredUnless(String, String...) - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option is required if the given option is absent on the command line.
requiredUnless(OptionSpec<?>, OptionSpec<?>...) - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option is required if the given option is absent on the command line.
requiresArgument() - Method in class joptsimple.ArgumentAcceptingOptionSpec
requiresArgument() - Method in class joptsimple.NonOptionArgumentSpec
requiresArgument() - Method in interface joptsimple.OptionDescriptor: Does this option require an argument?
revert(Object) - Method in class joptsimple.util.DateConverter
revert(Object) - Method in class joptsimple.util.EnumConverter
revert(Object) - Method in class joptsimple.util.InetAddressConverter
revert(Object) - Method in interface joptsimple.ValueConverter: Reverts a value to a string representation.

S

setDelimiters(String) - Method in class joptsimple.util.EnumConverter: Sets the delimiters for the message string.
specs() - Method in class joptsimple.OptionSet: Gives the set of options that were detected, in the form of OptionSpecs, in the order in which the options were found on the command line.

T

toString() - Method in class joptsimple.AbstractOptionSpec
toString() - Method in class joptsimple.util.KeyValuePair

V

value(OptionSet) - Method in class joptsimple.AbstractOptionSpec
value(OptionSet) - Method in interface joptsimple.OptionSpec: Gives the argument associated with the given option in the given set of detected options.
value - Variable in class joptsimple.util.KeyValuePair
ValueConversionException - Exception in joptsimple: Thrown by ValueConverters when problems occur in converting string values to other Java types.
ValueConversionException(String) - Constructor for exception joptsimple.ValueConversionException: Creates a new exception with the specified detail message.
ValueConversionException(String, Throwable) - Constructor for exception joptsimple.ValueConversionException: Creates a new exception with the specified detail message and cause.
ValueConverter<V> - Interface in joptsimple: Instances of this interface are used to convert arguments of options into specific Java types.
valueOf(String) - Method in class joptsimple.OptionSet: Gives the argument associated with the given option.
valueOf(OptionSpec<V>) - Method in class joptsimple.OptionSet: Gives the argument associated with the given option.
valueOf(String) - Static method in class joptsimple.util.KeyValuePair: Parses a string assumed to be of the form key=value into its parts.
valueOf(String) - Static method in enum joptsimple.util.PathProperties: Returns the enum constant of this type with the specified name.
valueOfOptional(String) - Method in class joptsimple.OptionSet: Gives the argument associated with the given option, as an Optional.
valueOfOptional(OptionSpec<V>) - Method in class joptsimple.OptionSet: Gives the argument associated with the given option as an Optional.
valueOptional(OptionSet) - Method in class joptsimple.AbstractOptionSpec
valueOptional(OptionSet) - Method in interface joptsimple.OptionSpec: Gives the argument associated with the given option in the given set of detected options as an Optional.
valuePattern() - Method in class joptsimple.util.DateConverter
valuePattern() - Method in class joptsimple.util.EnumConverter
valuePattern() - Method in class joptsimple.util.InetAddressConverter
valuePattern() - Method in class joptsimple.util.PathConverter
valuePattern() - Method in class joptsimple.util.RegexMatcher
valuePattern() - Method in interface joptsimple.ValueConverter: Gives a string that describes the pattern of the values this converter expects, if any.
values(OptionSet) - Method in class joptsimple.AbstractOptionSpec
values(OptionSet) - Method in interface joptsimple.OptionSpec: Gives any arguments associated with the given option in the given set of detected options.
values() - Static method in enum joptsimple.util.PathProperties: Returns an array containing the constants of this enum type, in the order they are declared.
valuesOf(String) - Method in class joptsimple.OptionSet: Gives any arguments associated with the given option.
valuesOf(OptionSpec<V>) - Method in class joptsimple.OptionSet: Gives any arguments associated with the given option.
valueType() - Method in class joptsimple.util.DateConverter
valueType() - Method in class joptsimple.util.EnumConverter
valueType() - Method in class joptsimple.util.InetAddressConverter
valueType() - Method in class joptsimple.util.PathConverter
valueType() - Method in class joptsimple.util.RegexMatcher
valueType() - Method in interface joptsimple.ValueConverter: Gives the class of the type of values this converter converts to.

W

withOptionalArg() - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option accepts an optional argument.
withRequiredArg() - Method in class joptsimple.OptionSpecBuilder: Informs an option parser that this builder's option requires an argument.
withValuesConvertedBy(ValueConverter<T>) - Method in class joptsimple.ArgumentAcceptingOptionSpec: Specifies a converter to use to translate arguments of this spec's option into Java objects.
withValuesConvertedBy(ValueConverter<T>) - Method in class joptsimple.NonOptionArgumentSpec: Specifies a converter to use to translate non-option arguments into Java objects.
withValuesSeparatedBy(char) - Method in class joptsimple.ArgumentAcceptingOptionSpec: Specifies a value separator for the argument of the option that this spec represents.
withValuesSeparatedBy(String) - Method in class joptsimple.ArgumentAcceptingOptionSpec: Specifies a value separator for the argument of the option that this spec represents.

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