|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjoptsimple.AbstractOptionSpec<V>
joptsimple.ArgumentAcceptingOptionSpec<V>
V - represents the type of the arguments this option acceptspublic abstract class ArgumentAcceptingOptionSpec<V>
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.
| Field Summary | |
|---|---|
private java.lang.String |
argumentDescription
|
private boolean |
argumentRequired
|
private ValueConverter<V> |
converter
|
private static char |
NIL_VALUE_SEPARATOR
|
private java.lang.String |
valueSeparator
|
| Constructor Summary | |
|---|---|
ArgumentAcceptingOptionSpec(java.util.Collection<java.lang.String> options,
boolean argumentRequired,
java.lang.String description)
|
|
ArgumentAcceptingOptionSpec(java.lang.String option,
boolean argumentRequired)
|
|
| Method Summary | ||
|---|---|---|
(package private) boolean |
acceptsArguments()
|
|
protected void |
addArguments(OptionSet detectedOptions,
java.lang.String detectedArgument)
|
|
(package private) java.lang.String |
argumentDescription()
|
|
protected boolean |
canConvertArgument(java.lang.String argument)
|
|
protected V |
convert(java.lang.String argument)
|
|
ArgumentAcceptingOptionSpec<V> |
describedAs(java.lang.String description)
Specifies a description for the argument of the option that this spec represents. |
|
protected abstract void |
detectOptionArgument(OptionParser parser,
ArgumentList arguments,
OptionSet detectedOptions)
|
|
boolean |
equals(java.lang.Object that)
|
|
(package private) void |
handleOption(OptionParser parser,
ArgumentList arguments,
OptionSet detectedOptions,
java.lang.String detectedArgument)
|
|
int |
hashCode()
|
|
protected boolean |
isArgumentOfNumberType()
|
|
|
ofType(java.lang.Class<T> argumentType)
Specifies a type to which arguments of this spec's option are to be converted. |
|
(package private) boolean |
requiresArgument()
|
|
(package private) java.lang.String |
typeIndicator()
|
|
|
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. |
|
| Methods inherited from class joptsimple.AbstractOptionSpec |
|---|
accept, description, options, toString, value, values |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
private static final char NIL_VALUE_SEPARATOR
private final boolean argumentRequired
private ValueConverter<V> converter
private java.lang.String argumentDescription
private java.lang.String valueSeparator
| Constructor Detail |
|---|
ArgumentAcceptingOptionSpec(java.lang.String option,
boolean argumentRequired)
ArgumentAcceptingOptionSpec(java.util.Collection<java.lang.String> options,
boolean argumentRequired,
java.lang.String description)
| Method Detail |
|---|
public final <T> ArgumentAcceptingOptionSpec<T> ofType(java.lang.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 option
java.lang.NullPointerException - if the type is null
java.lang.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 use
java.lang.NullPointerException - if the converter is nullpublic final ArgumentAcceptingOptionSpec<V> describedAs(java.lang.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
option
public 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 separator
java.lang.IllegalArgumentException - if the separator is Unicode U+0000
final void handleOption(OptionParser parser,
ArgumentList arguments,
OptionSet detectedOptions,
java.lang.String detectedArgument)
handleOption in class AbstractOptionSpec<V>
protected void addArguments(OptionSet detectedOptions,
java.lang.String detectedArgument)
protected abstract void detectOptionArgument(OptionParser parser,
ArgumentList arguments,
OptionSet detectedOptions)
protected final V convert(java.lang.String argument)
convert in class AbstractOptionSpec<V>protected boolean canConvertArgument(java.lang.String argument)
protected boolean isArgumentOfNumberType()
boolean acceptsArguments()
acceptsArguments in class AbstractOptionSpec<V>boolean requiresArgument()
requiresArgument in class AbstractOptionSpec<V>java.lang.String argumentDescription()
java.lang.String typeIndicator()
public boolean equals(java.lang.Object that)
equals in class AbstractOptionSpec<V>public int hashCode()
hashCode in class AbstractOptionSpec<V>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||