Package joptsimple
-
Interface Summary Interface Description HelpFormatter Represents objects charged with taking a set of option descriptions and producing some help text from them.OptionDeclarer Trains the option parser.OptionDescriptor Describes options that an option parser recognizes, in ways that might be useful to help screens.OptionSpec<V> Describes options that an option parser recognizes.ValueConverter<V> Instances of this interface are used to convert arguments of options into specific Java types. -
Class Summary Class Description AbstractOptionSpec<V> AlternativeLongOptionSpec Represents the"-W"
form of long option specification.ArgumentAcceptingOptionSpec<V> Specification of an option that accepts an argument.ArgumentList Wrapper for an array of command line arguments.BuiltinHelpFormatter A help formatter that allows configuration of overall row width and column separator width.NoArgumentOptionSpec A specification for an option that does not accept arguments.NonOptionArgumentSpec<V> Specification of a command line's non-option arguments.OptionalArgumentOptionSpec<V> Specification of an option that accepts an optional argument.OptionParser Parses command line arguments, using a syntax that attempts to take from the best of POSIXgetopt()
and GNUgetopt_long()
.OptionParserState Abstraction of parser state; mostly serves to model how a parser behaves depending on whether end-of-options has been detected.OptionSet Representation of a group of detected command line options, their arguments, and non-option arguments.OptionSpecBuilder Allows callers to specify whether a given option accepts arguments (required or optional).OptionSpecTokenizer Tokenizes a short option specification string.ParserRules Can tell whether or not options are well-formed.RequiredArgumentOptionSpec<V> Specification of an option that accepts a required argument. -
Exception Summary Exception Description IllegalOptionSpecificationException Thrown when the option parser is asked to recognize an option with illegal characters in it.MissingRequiredOptionsException Thrown when options marked as required are not specified on the command line.MultipleArgumentsForOptionException Thrown when asking anOptionSet
for a single argument of an option when many have been specified.OptionArgumentConversionException Thrown when a problem occurs converting an argument of an option fromString
to another type.OptionException Thrown when a problem occurs during option parsing.OptionMissingRequiredArgumentException Thrown when the option parser discovers options that require an argument, but are missing an argument.UnavailableOptionException Thrown when options marked as allowed are specified on the command line, but the options they depend upon are present/not present.UnconfiguredOptionException Thrown when an option parser refers to an option that is not in fact configured already on the parser.UnrecognizedOptionException Thrown when the option parser encounters an unrecognized option.ValueConversionException Thrown byValueConverter
s when problems occur in converting string values to other Java types.