public class OptionSpecBuilder extends Object
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 |
---|---|
boolean |
acceptsArguments()
Does this option accept arguments?
|
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 Void |
convert(String argument) |
protected V |
convertWith(ValueConverter<V> converter,
String argument) |
List<Void> |
defaultValues()
What values will the option take if none are specified on the command line?
|
String |
description()
Description of this option's purpose.
|
boolean |
equals(Object that) |
joptsimple.AbstractOptionSpec<V> |
forHelp() |
int |
hashCode() |
boolean |
isForHelp()
Tells whether this option is designated as a "help" option.
|
boolean |
isRequired()
Is this option required on a command line?
|
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.
|
OptionSpecBuilder |
requiredIf(OptionSpec<?> dependent,
OptionSpec<?>... otherDependents)
Informs an option parser that this builder's option is required if the given option is present on the command
line.
|
OptionSpecBuilder |
requiredIf(String dependent,
String... otherDependents)
Informs an option parser that this builder's option is required if the given option is present on the command
line.
|
OptionSpecBuilder |
requiredUnless(OptionSpec<?> dependent,
OptionSpec<?>... otherDependents)
Informs an option parser that this builder's option is required if the given option is absent on the command
line.
|
OptionSpecBuilder |
requiredUnless(String dependent,
String... otherDependents)
Informs an option parser that this builder's option is required if the given option is absent on the command
line.
|
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.
|
ArgumentAcceptingOptionSpec<String> |
withOptionalArg()
Informs an option parser that this builder's option accepts an optional argument.
|
ArgumentAcceptingOptionSpec<String> |
withRequiredArg()
Informs an option parser that this builder's option requires an argument.
|
public ArgumentAcceptingOptionSpec<String> withRequiredArg()
public ArgumentAcceptingOptionSpec<String> withOptionalArg()
public OptionSpecBuilder requiredIf(String dependent, String... otherDependents)
Informs an option parser that this builder's option is required if the given option is present on the command line.
For a given option, you should not mix this with requiredUnless
to avoid conflicts.
dependent
- an option whose presence on a command line makes this builder's option requiredotherDependents
- other options whose presence on a command line makes this builder's option requiredOptionException
- if any of the dependent options haven't been configured in the parser yetpublic OptionSpecBuilder requiredIf(OptionSpec<?> dependent, OptionSpec<?>... otherDependents)
Informs an option parser that this builder's option is required if the given option is present on the command line.
For a given option, you should not mix this with requiredUnless
to avoid conflicts.
This method recognizes only instances of options returned from the fluent interface methods.
dependent
- the option whose presence on a command line makes this builder's option requiredotherDependents
- other options whose presence on a command line makes this builder's option requiredpublic OptionSpecBuilder requiredUnless(String dependent, String... otherDependents)
Informs an option parser that this builder's option is required if the given option is absent on the command line.
For a given option, you should not mix this with requiredIf
to avoid conflicts.
dependent
- an option whose absence on a command line makes this builder's option requiredotherDependents
- other options whose absence on a command line makes this builder's option requiredOptionException
- if any of the dependent options haven't been configured in the parser yetpublic OptionSpecBuilder requiredUnless(OptionSpec<?> dependent, OptionSpec<?>... otherDependents)
Informs an option parser that this builder's option is required if the given option is absent on the command line.
For a given option, you should not mix this with requiredIf
to avoid conflicts.
This method recognizes only instances of options returned from the fluent interface methods.
dependent
- the option whose absence on a command line makes this builder's option requiredotherDependents
- other options whose absence on a command line makes this builder's option requiredpublic boolean acceptsArguments()
OptionDescriptor
public boolean requiresArgument()
OptionDescriptor
public boolean isRequired()
OptionDescriptor
public String argumentDescription()
OptionDescriptor
public String argumentTypeIndicator()
OptionDescriptor
public List<Void> defaultValues()
OptionDescriptor
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.