Package 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:
OptionDescriptor, 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 Details

    • 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

    • withValuesSeparatedBy

      public final ArgumentAcceptingOptionSpec<V> withValuesSeparatedBy​(java.lang.String 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 in the separator.

      Parameters:
      separator - a string separator
      Returns:
      self, so that the caller can add clauses to the fluent interface sentence
      Throws:
      java.lang.IllegalArgumentException - if the separator contains 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
      Throws:
      java.lang.NullPointerException - if value, values, or any elements of values are null

    • defaultsTo

      public ArgumentAcceptingOptionSpec<V> defaultsTo​(V[] values)
      Specifies a set of default values for the argument of the option that this spec represents.
      Parameters:
      values - 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
      Throws:
      java.lang.NullPointerException - if values or any elements of values are null

    • required

      public ArgumentAcceptingOptionSpec<V> required()
      Marks this option as required. An OptionException will be thrown when OptionParser.parse(java.lang.String...) is called, if an option is marked as required and not specified on the command line.
      Returns:
      self, so that the caller can add clauses to the fluent interface sentence

    • isRequired

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

    • addArguments

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

    • detectOptionArgument

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

    • convert

      protected final V convert​(java.lang.String argument)

    • canConvertArgument

      protected boolean canConvertArgument​(java.lang.String argument)

    • isArgumentOfNumberType

      protected boolean isArgumentOfNumberType()

    • 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

    • argumentDescription

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

    • defaultValues

      public java.util.List<V> 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

    • equals

      public boolean equals​(java.lang.Object that)

    • hashCode

      public int hashCode()

    • options

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

    • description

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

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object