public class OptionSpecBuilder
extends java.lang.Object
Allows callers to specify whether a given option accepts arguments (required or optional).
Instances are returned from OptionParser.accepts(String)
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 accept no argument.
Note that you should not use the fluent interface clauses in a way that would defeat the typing of option arguments:
OptionParser parser = new OptionParser();
ArgumentAcceptingOptionSpec<String> optionC =
parser.accepts( "c" ).withRequiredArg();
optionC.ofType( Integer.class ); // DON'T THROW AWAY THE TYPE!
String value = parser.parse( "-c", "2" ).valueOf( optionC ); // ClassCastException
Modifier and Type | Method and Description |
---|---|
protected java.lang.Void |
convert(java.lang.String argument) |
boolean |
equals(java.lang.Object that) |
int |
hashCode() |
java.util.Collection<java.lang.String> |
options() |
java.lang.String |
toString() |
V |
value(OptionSet detectedOptions)
Gives the argument associated with the given option in the given set of
detected options.
|
java.util.List<V> |
values(OptionSet detectedOptions)
Gives any arguments associated with the given option in the given set of
detected options.
|
ArgumentAcceptingOptionSpec<java.lang.String> |
withOptionalArg()
Informs an option parser that this builder's option accepts an optional
argument.
|
ArgumentAcceptingOptionSpec<java.lang.String> |
withRequiredArg()
Informs an option parser that this builder's option requires an argument.
|
public ArgumentAcceptingOptionSpec<java.lang.String> withRequiredArg()
Informs an option parser that this builder's option requires an argument.
public ArgumentAcceptingOptionSpec<java.lang.String> withOptionalArg()
Informs an option parser that this builder's option accepts an optional argument.
protected java.lang.Void convert(java.lang.String argument)
public final java.util.Collection<java.lang.String> options()
options
in interface OptionSpec<V>
public final java.util.List<V> values(OptionSet detectedOptions)
OptionSpec
Gives any arguments associated with the given option in the given set of detected options.
values
in interface OptionSpec<V>
detectedOptions
- the detected options to search inpublic final V value(OptionSet detectedOptions)
OptionSpec
Gives the argument associated with the given option in the given set of detected options.
value
in interface OptionSpec<V>
detectedOptions
- the detected options to search innull
if no argument is present,
or that option was not detectedpublic boolean equals(java.lang.Object that)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object