V
- represents the type of the arguments this option acceptspublic abstract class ArgumentAcceptingOptionSpec<V> extends Object
Specification of an option that accepts an argument.
Instances are returned from OptionSpecBuilder
methods to allow the formation of parser directives as
sentences in a "fluent interface" language. For example:
OptionParser parser = new OptionParser();
parser.accepts( "c" ).withRequiredArg().ofType( Integer.class );
If no methods are invoked on an instance of this class, then that instance's option will treat its argument as
a String
.
Modifier and Type | Method and Description |
---|---|
boolean |
acceptsArguments()
Does this option accept arguments?
|
protected void |
addArguments(OptionSet detectedOptions,
String detectedArgument) |
String |
argumentDescription()
Gives a short description of the option's argument.
|
String |
argumentTypeIndicator()
Gives an indication of the expected type of the option's
argument.
|
protected String |
argumentTypeIndicatorFrom(ValueConverter<V> converter) |
protected boolean |
canConvertArgument(String argument) |
protected V |
convert(String argument) |
protected V |
convertWith(ValueConverter<V> converter,
String argument) |
ArgumentAcceptingOptionSpec<V> |
defaultsTo(V[] values)
Specifies a set of default values for the argument of the option that this spec represents.
|
ArgumentAcceptingOptionSpec<V> |
defaultsTo(V value,
V... values)
Specifies a set of default values for the argument of the option that this spec represents.
|
List<V> |
defaultValues()
What values will the option take if none are specified on the command line?
|
ArgumentAcceptingOptionSpec<V> |
describedAs(String description)
Specifies a description for the argument of the option that this spec represents.
|
String |
description()
Description of this option's purpose.
|
protected abstract void |
detectOptionArgument(OptionParser parser,
joptsimple.ArgumentList arguments,
OptionSet detectedOptions) |
boolean |
equals(Object that) |
joptsimple.AbstractOptionSpec<V> |
forHelp() |
int |
hashCode() |
protected boolean |
isArgumentOfNumberType() |
boolean |
isForHelp()
Tells whether this option is designated as a "help" option.
|
boolean |
isRequired()
Is this option required on a command line?
|
<T> ArgumentAcceptingOptionSpec<T> |
ofType(Class<T> argumentType)
Specifies a type to which arguments of this spec's option are to be converted.
|
Collection<String> |
options()
A set of options that are mutually synonymous.
|
boolean |
representsNonOptions()
Tells whether this object represents the non-option arguments of a command line.
|
ArgumentAcceptingOptionSpec<V> |
required()
Marks this option as required.
|
boolean |
requiresArgument()
Does this option require an argument?
|
String |
toString() |
V |
value(OptionSet detectedOptions)
Gives the argument associated with the given option in the given set of detected options.
|
List<V> |
values(OptionSet detectedOptions)
Gives any arguments associated with the given option in the given set of detected options.
|
<T> ArgumentAcceptingOptionSpec<T> |
withValuesConvertedBy(ValueConverter<T> aConverter)
Specifies a converter to use to translate arguments of this spec's option into Java objects.
|
ArgumentAcceptingOptionSpec<V> |
withValuesSeparatedBy(char separator)
Specifies a value separator for the argument of the option that this spec represents.
|
ArgumentAcceptingOptionSpec<V> |
withValuesSeparatedBy(String separator)
Specifies a value separator for the argument of the option that this spec represents.
|
public final <T> ArgumentAcceptingOptionSpec<T> ofType(Class<T> argumentType)
Specifies a type to which arguments of this spec's option are to be converted.
JOpt Simple accepts types that have either:
valueOf
which accepts a single argument of type String
and whose return type is the same as the class on which the method is declared. The java.lang
primitive wrapper classes have such methods.String
.This class converts arguments using those methods in that order; that is, valueOf
would be invoked
before a one-String
-arg constructor would.
Invoking this method will trump any previous calls to this method or to
withValuesConvertedBy(ValueConverter)
.
T
- represents the runtime class of the desired option argument typeargumentType
- desired type of arguments to this spec's optionNullPointerException
- if the type is null
IllegalArgumentException
- if the type does not have the standard conversion methodspublic final <T> ArgumentAcceptingOptionSpec<T> withValuesConvertedBy(ValueConverter<T> aConverter)
Specifies a converter to use to translate arguments of this spec's option into Java objects. This is useful
when converting to types that do not have the requisite factory method or constructor for
ofType(Class)
.
Invoking this method will trump any previous calls to this method or to ofType(Class)
.
T
- represents the runtime class of the desired option argument typeaConverter
- the converter to useNullPointerException
- if the converter is null
public final ArgumentAcceptingOptionSpec<V> describedAs(String description)
Specifies a description for the argument of the option that this spec represents. This description is used when generating help information about the parser.
description
- describes the nature of the argument of this spec's optionpublic final ArgumentAcceptingOptionSpec<V> withValuesSeparatedBy(char separator)
Specifies a value separator for the argument of the option that this spec represents. This allows a single option argument to represent multiple values for the option. For example:
parser.accepts( "z" ).withRequiredArg()
.withValuesSeparatedBy( ',' );
OptionSet options = parser.parse( new String[] { "-z", "foo,bar,baz", "-z",
"fizz", "-z", "buzz" } );
Then options.valuesOf( "z" )
would yield the list [foo, bar, baz, fizz, buzz]
.
You cannot use Unicode U+0000 as the separator.
separator
- a character separatorIllegalArgumentException
- if the separator is Unicode U+0000public final ArgumentAcceptingOptionSpec<V> withValuesSeparatedBy(String separator)
Specifies a value separator for the argument of the option that this spec represents. This allows a single option argument to represent multiple values for the option. For example:
parser.accepts( "z" ).withRequiredArg()
.withValuesSeparatedBy( ":::" );
OptionSet options = parser.parse( new String[] { "-z", "foo:::bar:::baz", "-z",
"fizz", "-z", "buzz" } );
Then options.valuesOf( "z" )
would yield the list [foo, bar, baz, fizz, buzz]
.
You cannot use Unicode U+0000 in the separator.
separator
- a string separatorIllegalArgumentException
- if the separator contains Unicode U+0000public ArgumentAcceptingOptionSpec<V> defaultsTo(V value, V... values)
value
- the first in the set of default argument values for this spec's optionvalues
- the (optional) remainder of the set of default argument values for this spec's optionNullPointerException
- if value
, values
, or any elements of values
are
null
public ArgumentAcceptingOptionSpec<V> defaultsTo(V[] values)
values
- the set of default argument values for this spec's optionNullPointerException
- if values
or any elements of values
are null
public ArgumentAcceptingOptionSpec<V> required()
OptionException
will be thrown when
OptionParser.parse(java.lang.String...)
is called, if an option is marked as required and not specified
on the command line.public boolean isRequired()
OptionDescriptor
protected abstract void detectOptionArgument(OptionParser parser, joptsimple.ArgumentList arguments, OptionSet detectedOptions)
protected boolean canConvertArgument(String argument)
protected boolean isArgumentOfNumberType()
public boolean acceptsArguments()
OptionDescriptor
public boolean requiresArgument()
OptionDescriptor
public String argumentDescription()
OptionDescriptor
public String argumentTypeIndicator()
OptionDescriptor
public List<V> defaultValues()
OptionDescriptor
public boolean equals(Object that)
public int hashCode()
public final Collection<String> options()
OptionDescriptor
options
in interface OptionDescriptor
options
in interface OptionSpec<V>
public final List<V> values(OptionSet detectedOptions)
OptionSpec
Specifying a default argument value for this option will cause this method to return that default value even if this option was not detected on the command line, or if this option can take an optional argument but did not have one on the command line.
values
in interface OptionSpec<V>
detectedOptions
- the detected options to search inOptionSet.valuesOf(OptionSpec)
public final V value(OptionSet detectedOptions)
OptionSpec
Specifying a default argument value for this option will cause this method to return that default value even if this option was not detected on the command line, or if this option can take an optional argument but did not have one on the command line.
value
in interface OptionSpec<V>
detectedOptions
- the detected options to search innull
if no argument is present, or that option was not detectedOptionSet.valueOf(OptionSpec)
public String description()
OptionDescriptor
description
in interface OptionDescriptor
public final joptsimple.AbstractOptionSpec<V> forHelp()
public final boolean isForHelp()
OptionSpec
isForHelp
in interface OptionSpec<V>
public boolean representsNonOptions()
OptionDescriptor
representsNonOptions
in interface OptionDescriptor
true
if this represents non-option argumentsprotected V convertWith(ValueConverter<V> converter, String argument)
protected String argumentTypeIndicatorFrom(ValueConverter<V> converter)
Copyright © 2014. All rights reserved.