joptsimple
Class OptionSpecBuilder

java.lang.Object
  extended by joptsimple.OptionSpecBuilder
All Implemented Interfaces:
OptionDescriptor, OptionSpec<Void>

public class OptionSpecBuilder
extends 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
 

Author:
Paul Holser

Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

withRequiredArg

public ArgumentAcceptingOptionSpec<String> withRequiredArg()
Informs an option parser that this builder's option requires an argument.

Returns:
a specification for the option

withOptionalArg

public ArgumentAcceptingOptionSpec<String> withOptionalArg()
Informs an option parser that this builder's option accepts an optional argument.

Returns:
a specification for the option

requiredIf

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.

Parameters:
dependent - an option whose presence on a command line makes this builder's option required
otherDependents - other options whose presence on a command line makes this builder's option required
Returns:
self, so that the caller can add clauses to the fluent interface sentence
Throws:
OptionException - if any of the dependent options haven't been configured in the parser yet

requiredIf

public 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.

Parameters:
dependent - the option whose presence on a command line makes this builder's option required
otherDependents - other options whose presence on a command line makes this builder's option required
Returns:
self, so that the caller can add clauses to the fluent interface sentence

requiredUnless

public 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.

Parameters:
dependent - an option whose absence on a command line makes this builder's option required
otherDependents - other options whose absence on a command line makes this builder's option required
Returns:
self, so that the caller can add clauses to the fluent interface sentence
Throws:
OptionException - if any of the dependent options haven't been configured in the parser yet

requiredUnless

public 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.

Parameters:
dependent - the option whose absence on a command line makes this builder's option required
otherDependents - other options whose absence on a command line makes this builder's option required
Returns:
self, so that the caller can add clauses to the fluent interface sentence

acceptsArguments

public boolean acceptsArguments()
Description copied from interface: OptionDescriptor
Does this option accept arguments?

Returns:
whether the option accepts arguments

requiresArgument

public boolean requiresArgument()
Description copied from interface: OptionDescriptor
Does this option require an argument?

Returns:
whether the option requires an argument

isRequired

public boolean isRequired()
Description copied from interface: OptionDescriptor
Is this option required on a command line?

Returns:
whether the option is required

argumentDescription

public String argumentDescription()
Description copied from interface: OptionDescriptor
Gives a short description of the option's argument.

Returns:
a description for the option's argument

argumentTypeIndicator

public String argumentTypeIndicator()
Description copied from interface: OptionDescriptor
Gives an indication of the expected type of the option's argument.

Returns:
a description for the option's argument type

convert

protected Void convert(String argument)

defaultValues

public List<Void> defaultValues()
Description copied from interface: OptionDescriptor
What values will the option take if none are specified on the command line?

Returns:
any default values for the option

options

public final Collection<String> options()
Description copied from interface: OptionDescriptor
A set of options that are mutually synonymous.

Specified by:
options in interface OptionDescriptor
Specified by:
options in interface OptionSpec<V>
Returns:
the string representations of this option

values

public final List<V> values(OptionSet detectedOptions)
Description copied from interface: OptionSpec
Gives any arguments associated with the given option in the given set of detected options.

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.

Specified by:
values in interface OptionSpec<V>
Parameters:
detectedOptions - the detected options to search in
Returns:
the arguments associated with this option; an empty list if no such arguments are present, or if this option was not detected
See Also:
OptionSet.valuesOf(OptionSpec)

value

public final V value(OptionSet detectedOptions)
Description copied from interface: OptionSpec
Gives the argument associated with the given option in the given set of detected options.

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.

Specified by:
value in interface OptionSpec<V>
Parameters:
detectedOptions - the detected options to search in
Returns:
the argument of the this option; null if no argument is present, or that option was not detected
See Also:
OptionSet.valueOf(OptionSpec)

description

public String description()
Description copied from interface: OptionDescriptor
Description of this option's purpose.

Specified by:
description in interface OptionDescriptor
Returns:
a description for the option

forHelp

public final joptsimple.AbstractOptionSpec<V> forHelp()

isForHelp

public final boolean isForHelp()
Description copied from interface: OptionSpec
Tells whether this option is designated as a "help" option. The presence of a "help" option on a command line means that missing "required" options will not cause parsing to fail.

Specified by:
isForHelp in interface OptionSpec<V>
Returns:
whether this option is designated as a "help" option

representsNonOptions

public boolean representsNonOptions()
Description copied from interface: OptionDescriptor
Tells whether this object represents the non-option arguments of a command line.

Specified by:
representsNonOptions in interface OptionDescriptor
Returns:
true if this represents non-option arguments

convertWith

protected V convertWith(ValueConverter<V> converter,
                        String argument)

argumentTypeIndicatorFrom

protected String argumentTypeIndicatorFrom(ValueConverter<V> converter)

equals

public boolean equals(Object that)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2014. All Rights Reserved.