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

A

AbbreviationMap<V> - Class in joptsimple.internal

A map whose keys are strings; when a key/value pair is added to the map, the longest unique abbreviations of that key are added as well, and associated with the value.

AbbreviationMap() - Constructor for class joptsimple.internal.AbbreviationMap

accepts(String) - Method in class joptsimple.OptionParser

Tells the parser to recognize the given option.

accepts(String, String) - Method in class joptsimple.OptionParser

Tells the parser to recognize the given option.

acceptsAll(Collection<String>) - Method in class joptsimple.OptionParser

Tells the parser to recognize the given options, and treat them as synonymous.

acceptsAll(Collection<String>, String) - Method in class joptsimple.OptionParser

Tells the parser to recognize the given options, and treat them as synonymous.

acceptsArguments() - Method in class joptsimple.ArgumentAcceptingOptionSpec

acceptsArguments() - Method in interface joptsimple.OptionDescriptor

Does this option accept arguments?

addArguments(OptionSet, String) - Method in class joptsimple.ArgumentAcceptingOptionSpec

addRow(Object...) - Method in class joptsimple.internal.ColumnarData

Adds a row to the grid.

ArgumentAcceptingOptionSpec<V> - Class in joptsimple

Specification of an option that accepts an argument.

argumentDescription() - Method in class joptsimple.ArgumentAcceptingOptionSpec

argumentDescription() - Method in interface joptsimple.OptionDescriptor

Gives a short description of the option's argument.

argumentTypeIndicator() - Method in class joptsimple.ArgumentAcceptingOptionSpec

argumentTypeIndicator() - Method in interface joptsimple.OptionDescriptor

Gives an indication of the expected type of the option's argument.

C

canConvertArgument(String) - Method in class joptsimple.ArgumentAcceptingOptionSpec

Classes - Class in joptsimple.internal

clear() - Method in class joptsimple.internal.ColumnarData

Removes all data from the grid, but preserves the headers.

Column - Class in joptsimple.internal

ColumnarData - Class in joptsimple.internal

A means to display data in a text grid.

ColumnarData(String...) - Constructor for class joptsimple.internal.ColumnarData

Creates a new grid with the given column headers.

contains(String) - Method in class joptsimple.internal.AbbreviationMap

Tells whether the given key is in the map, or whether the given key is a unique abbreviation of a key that is in the map.

convert(String) - Method in class joptsimple.ArgumentAcceptingOptionSpec

convert(String) - Method in class joptsimple.util.DateConverter

Converts the given string value into a Java type.

convert(String) - Method in class joptsimple.util.RegexMatcher

Converts the given string value into a Java type.

convert(String) - Method in interface joptsimple.ValueConverter

Converts the given string value into a Java type.

createUnrecognizedOptionException(String, OptionSet) - Static method in exception joptsimple.OptionException

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

description() - Method in interface joptsimple.OptionDescriptor

Description of this option's purpose.

detectOptionArgument(OptionParser, ArgumentList, OptionSet) - Method in class joptsimple.ArgumentAcceptingOptionSpec

E

EMPTY - Static variable in class joptsimple.internal.Strings

ensureNotNull(Object) - Static method in class joptsimple.internal.Objects

Rejects null references.

equals(Object) - Method in class joptsimple.ArgumentAcceptingOptionSpec

equals(Object) - Method in class joptsimple.OptionSet

equals(Object) - Method in class joptsimple.util.KeyValuePair

F

findConverter(Class<V>) - Static method in class joptsimple.internal.Reflection

Finds an appropriate value converter for the given class.

format(Map<String, ? extends OptionDescriptor>) - Method in interface joptsimple.HelpFormatter

Produces help text, given a set of option descriptors.

format() - Method in class joptsimple.internal.ColumnarData

Gives a string that represents the data formatted in columns.

formatHelpWith(HelpFormatter) - Method in class joptsimple.OptionParser

Tells the parser to use the given formatter when asked to print help.

G

get(String) - Method in class joptsimple.internal.AbbreviationMap

Answers the value associated with the given key.

getDetected() - Method in exception joptsimple.OptionException

getMessage() - Method in exception joptsimple.IllegalOptionSpecificationException

getMessage() - Method in exception joptsimple.MissingRequiredOptionException

getMessage() - Method in exception joptsimple.MultipleArgumentsForOptionException

getMessage() - Method in exception joptsimple.OptionArgumentConversionException

getMessage() - Method in exception joptsimple.OptionMissingRequiredArgumentException

getMessage() - Method in exception joptsimple.UnrecognizedOptionException

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

IllegalOptionSpecificationException - Exception in joptsimple

Thrown when the option parser is asked to recognize an option with illegal characters in it.

instantiate(Constructor<T>, Object...) - Static method in class joptsimple.internal.Reflection

Invokes the given constructor with the given arguments.

invoke(Method, Object...) - Static method in class joptsimple.internal.Reflection

Invokes the given static method with the given arguments.

isArgumentOfNumberType() - Method in class joptsimple.ArgumentAcceptingOptionSpec

isForHelp() - Method in interface joptsimple.OptionSpec

Tells whether this option is designated as a "help" option.

isNullOrEmpty(String) - Static method in class joptsimple.internal.Strings

Tells whether the given string is either or consists solely of whitespace characters.

isRequired() - Method in class joptsimple.ArgumentAcceptingOptionSpec

isRequired() - Method in interface joptsimple.OptionDescriptor

Is this option required on a command line?

isShortOptionDisabled() - Method in class joptsimple.OptionParser

J

join(String[], String) - Static method in class joptsimple.internal.Strings

Gives a string consisting of the elements of a given array of strings, each separated by a given separator string.

join(List<String>, String) - Static method in class joptsimple.internal.Strings

Gives a string consisting of the string representations of the elements of a given array of objects, each separated by a given separator string.

joptsimple - package joptsimple

joptsimple.internal - package joptsimple.internal

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.

L

LINE_SEPARATOR - Static variable in class joptsimple.internal.Strings

M

MissingRequiredOptionException - Exception in joptsimple

Thrown when an option is marked as required, but not specified on the command line.

MissingRequiredOptionException(Collection<String>) - Constructor for exception joptsimple.MissingRequiredOptionException

MultipleArgumentsForOptionException - Exception in joptsimple

Thrown when asking an OptionSet for a single argument of an option when many have been specified.

MultipleArgumentsForOptionException(Collection<String>, OptionSet) - Constructor for exception joptsimple.MultipleArgumentsForOptionException

multipleOptionMessage() - Method in exception joptsimple.OptionException

N

nonOptionArguments() - Method in class joptsimple.OptionSet

O

Objects - Class in joptsimple.internal

ofType(Class<T>) - Method in class joptsimple.ArgumentAcceptingOptionSpec

Specifies a type to which arguments of this spec's option are to be converted.

OptionArgumentConversionException - Exception in joptsimple

Thrown when a problem occurs converting an argument of an option from String to another type.

OptionArgumentConversionException(Collection<String>, String, Class<?>, OptionSet, Throwable) - Constructor for exception joptsimple.OptionArgumentConversionException

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.

OptionException(Collection<String>) - Constructor for exception joptsimple.OptionException

OptionException(Collection<String>, Throwable) - Constructor for exception joptsimple.OptionException

OptionException(Collection<String>, OptionSet) - Constructor for exception joptsimple.OptionException

OptionMissingRequiredArgumentException - Exception in joptsimple

Thrown when the option parser discovers an option that requires an argument, but that argument is missing.

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(String) - Constructor for class joptsimple.OptionParser

Creates an option parser and configures it to recognize the short options specified in the given string.

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

posixlyCorrect(boolean) - Method in class joptsimple.OptionParser

Tells the parser whether or not to behave "POSIX-ly correct"-ly.

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.

put(String, V) - Method in class joptsimple.internal.AbbreviationMap

Associates a given value with a given key.

putAll(Iterable<String>, V) - Method in class joptsimple.internal.AbbreviationMap

Associates a given value with a given set of keys.

R

recognizeAlternativeLongOptions(boolean) - Method in class joptsimple.OptionParser

Tells the parser either to recognize or ignore "-W"-style long options.

Reflection - Class in joptsimple.internal

Helper methods for reflection.

ReflectionException - Exception in joptsimple.internal

This unchecked exception wraps reflection-oriented exceptions.

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.

remove(String) - Method in class joptsimple.internal.AbbreviationMap

If the map contains the given key, dissociates the key from its value.

repeat(char, int) - Static method in class joptsimple.internal.Strings

Gives a string consisting of the given character repeated the given number of times.

required() - Method in class joptsimple.ArgumentAcceptingOptionSpec

Marks this option as required.

requiresArgument() - Method in class joptsimple.ArgumentAcceptingOptionSpec

requiresArgument() - Method in interface joptsimple.OptionDescriptor

Does this option require an argument?

S

shortNameOf(String) - Static method in class joptsimple.internal.Classes

Gives the "short version" of the given class name.

SINGLE_QUOTE - Static variable in class joptsimple.internal.Strings

singleOptionMessage() - Method in exception joptsimple.OptionException

singleOptionMessage(String) - Method in exception joptsimple.OptionException

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.

Strings - Class in joptsimple.internal

surround(String, char, char) - Static method in class joptsimple.internal.Strings

Gives a string consisting of a given string prepended and appended with surrounding characters.

T

toJavaUtilMap() - Method in class joptsimple.internal.AbbreviationMap

Gives a Java map representation of this abbreviation map.

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

U

UnrecognizedOptionException - Exception in joptsimple

Thrown when the option parser encounters an unrecognized option.

V

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.

valuePattern() - Method in class joptsimple.util.DateConverter

Gives a string that describes the pattern of the values this converter expects, if any.

valuePattern() - Method in class joptsimple.util.RegexMatcher

Gives a string that describes the pattern of the values this converter expects, if any.

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 interface joptsimple.OptionSpec

Gives any arguments associated with the given option in the given set of detected options.

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

Gives the class of the type of values this converter converts to.

valueType() - Method in class joptsimple.util.RegexMatcher

Gives the class of the type of values this converter converts to.

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.

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.

wrapperOf(Class<T>) - Static method in class joptsimple.internal.Classes

Gives the primitive wrapper class for the given class.

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