joptsimple
Class ArgumentAcceptingOptionSpec<V>

java.lang.Object
  extended by joptsimple.AbstractOptionSpec<V>
      extended by joptsimple.ArgumentAcceptingOptionSpec<V>
Type Parameters:
V - represents the type of the arguments this option accepts
All Implemented Interfaces:
OptionSpec<V>
Direct Known Subclasses:
AlternativeLongOptionSpec, OptionalArgumentOptionSpec, RequiredArgumentOptionSpec

public abstract class ArgumentAcceptingOptionSpec<V>
extends AbstractOptionSpec<V>

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.

Version:
$Id: ArgumentAcceptingOptionSpec.java,v 1.36 2009/04/04 01:24:27 pholser Exp $
Author:
Paul Holser

Field Summary
private  java.lang.String argumentDescription
           
private  boolean argumentRequired
           
private  ValueConverter<V> converter
           
private static char NIL_VALUE_SEPARATOR
           
private  java.lang.String valueSeparator
           
 
Constructor Summary
ArgumentAcceptingOptionSpec(java.util.Collection<java.lang.String> 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()
           
protected  boolean canConvertArgument(java.lang.String argument)
           
protected  V convert(java.lang.String argument)
           
 ArgumentAcceptingOptionSpec<V> 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()
           
<T> ArgumentAcceptingOptionSpec<T>
ofType(java.lang.Class<T> argumentType)
          Specifies a type to which arguments of this spec's option are to be converted.
(package private)  boolean requiresArgument()
           
(package private)  java.lang.String typeIndicator()
           
<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 joptsimple.AbstractOptionSpec
accept, description, options, toString, value, values
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NIL_VALUE_SEPARATOR

private static final char NIL_VALUE_SEPARATOR
See Also:
Constant Field Values

argumentRequired

private final boolean argumentRequired

converter

private ValueConverter<V> converter

argumentDescription

private java.lang.String argumentDescription

valueSeparator

private java.lang.String valueSeparator
Constructor Detail

ArgumentAcceptingOptionSpec

ArgumentAcceptingOptionSpec(java.lang.String option,
                            boolean argumentRequired)

ArgumentAcceptingOptionSpec

ArgumentAcceptingOptionSpec(java.util.Collection<java.lang.String> options,
                            boolean argumentRequired,
                            java.lang.String description)
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

handleOption

final void handleOption(OptionParser parser,
                        ArgumentList arguments,
                        OptionSet detectedOptions,
                        java.lang.String detectedArgument)
Specified by:
handleOption in class AbstractOptionSpec<V>

addArguments

protected void addArguments(OptionSet detectedOptions,
                            java.lang.String detectedArgument)

detectOptionArgument

protected abstract void detectOptionArgument(OptionParser parser,
                                             ArgumentList arguments,
                                             OptionSet detectedOptions)

convert

protected final V convert(java.lang.String argument)
Specified by:
convert in class AbstractOptionSpec<V>

canConvertArgument

protected boolean canConvertArgument(java.lang.String argument)

isArgumentOfNumberType

protected boolean isArgumentOfNumberType()

acceptsArguments

boolean acceptsArguments()
Specified by:
acceptsArguments in class AbstractOptionSpec<V>

requiresArgument

boolean requiresArgument()
Specified by:
requiresArgument in class AbstractOptionSpec<V>

argumentDescription

java.lang.String argumentDescription()

typeIndicator

java.lang.String typeIndicator()

equals

public boolean equals(java.lang.Object that)

Overrides:
equals in class AbstractOptionSpec<V>

hashCode

public int hashCode()

Overrides:
hashCode in class AbstractOptionSpec<V>