Package joptsimple

Class ArgumentAcceptingOptionSpec<V>

  • Type Parameters:
    V - represents the type of the arguments this option accepts
    All Implemented Interfaces:
    OptionDescriptor, 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.

    • Field Detail

      • argumentRequired

        private final boolean argumentRequired

      • defaultValues

        private final java.util.List<V> defaultValues

      • optionRequired

        private boolean optionRequired

      • 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.List<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

      • 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

        @SafeVarargs
public final 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

      • isRequired

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

      • addDefaultValue

        private void addDefaultValue​(V value)

      • addArguments

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

      • 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