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