joptsimple

Class ArgumentAcceptingOptionSpec<V>

java.lang.Object

joptsimple.ArgumentAcceptingOptionSpec<V>

Type Parameters:

V - represents the type of the arguments this option accepts

All Implemented Interfaces:

OptionSpec<V>

public abstract class ArgumentAcceptingOptionSpec<V>
extends java.lang.Object

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.

Method Summary

Modifier and Type	Method and Description
ArgumentAcceptingOptionSpec<V>	defaultsTo(V value, V... values) Specifies a set of default values for the argument of the option that this spec represents.
ArgumentAcceptingOptionSpec<V>	describedAs(java.lang.String description) Specifies a description for the argument of the option that this spec represents.
boolean	equals(java.lang.Object that)
int	hashCode()
<T> ArgumentAcceptingOptionSpec<T>	ofType(java.lang.Class<T> argumentType) Specifies a type to which arguments of this spec's option are to be converted.
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.
<T> ArgumentAcceptingOptionSpec<T>	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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

ofType

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:

1. a public static method called 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.
2. a public constructor which accepts a single argument of type 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).

Type Parameters:

T - represents the runtime class of the desired option argument type

Parameters:

argumentType - desired type of arguments to this spec's option

Returns:

self, so that the caller can add clauses to the fluent interface sentence

Throws:

java.lang.NullPointerException - if the type is null

java.lang.IllegalArgumentException - if the type does not have the standard conversion methods

withValuesConvertedBy

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

Type Parameters:

T - represents the runtime class of the desired option argument type

Parameters:

aConverter - the converter to use

Returns:

self, so that the caller can add clauses to the fluent interface sentence

Throws:

java.lang.NullPointerException - if the converter is null

describedAs

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

Parameters:

description - describes the nature of the argument of this spec's option

Returns:

self, so that the caller can add clauses to the fluent interface sentence

withValuesSeparatedBy

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.

Parameters:

separator - a character separator

Returns:

self, so that the caller can add clauses to the fluent interface sentence

Throws:

java.lang.IllegalArgumentException - if the separator is Unicode U+0000

defaultsTo

public ArgumentAcceptingOptionSpec<V> defaultsTo(V value,
                                                 V... values)

Specifies a set of default values for the argument of the option that this spec represents.

Parameters:

value - the first in the set of default argument values for this spec's option

values - the (optional) remainder of the set of default argument values for this spec's option

Returns:

self, so that the caller can add clauses to the fluent interface sentence

equals

public boolean equals(java.lang.Object that)

hashCode

public int hashCode()

options

public final java.util.Collection<java.lang.String> options()

Specified by:

options in interface OptionSpec<V>

Returns:

the string representations of this option

values

public final java.util.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)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object