Package org.apache.commons.cli

Class CommandLine

java.lang.Object
org.apache.commons.cli.CommandLine
All Implemented Interfaces:
Serializable
public class CommandLine extends Object implements Serializable
Represents list of arguments parsed against a Options descriptor.

It allows querying of a boolean hasOption(String optionName), in addition to retrieving the getOptionValue(String optionName) for options requiring arguments.

Additionally, any left-over or unrecognized arguments, are available for further processing.

See Also:

  • Constructor Details

    • CommandLine

      protected CommandLine()
      Creates a command line.

  • Method Details

    • builder

      public static CommandLine.Builder builder()
      Creates a new builder.
      Returns:
      a new builder.
      Since:
      1.7.0

    • addArg

      protected void addArg(String arg)
      Adds left-over unrecognized option/argument.
      Parameters:
      arg - the unrecognized option/argument.

    • addOption

      protected void addOption(Option option)
      Adds an option to the command line. The values of the option are stored.
      Parameters:
      option - the processed option.

    • getArgList

      public List<String> getArgList()
      Gets any left-over non-recognized options and arguments
      Returns:
      remaining items passed in but not parsed as a List.

    • getArgs

      public String[] getArgs()
      Gets any left-over non-recognized options and arguments
      Returns:
      remaining items passed in but not parsed as an array.

    • getOptionObject

      @Deprecated public Object getOptionObject(char optionChar)
      Deprecated.
      due to System.err message. Instead use getParsedOptionValue(char)
      Gets the Object type of this Option.
      Parameters:
      optionChar - the name of the option.
      Returns:
      the type of opt.

    • getOptionObject

      @Deprecated public Object getOptionObject(String optionName)
      Deprecated.
      due to System.err message. Instead use getParsedOptionValue(String)
      Gets the Object type of this Option.
      Parameters:
      optionName - the name of the option.
      Returns:
      the type of this Option.

    • getOptionProperties

      public Properties getOptionProperties(Option option)
      Gets the map of values associated to the option. This is convenient for options specifying Java properties like -Dparam1=value1 -Dparam2=value2. All odd numbered values are property keys and even numbered values are property values. If there are an odd number of values the last value is assumed to be a boolean flag and the value is "true".
      Parameters:
      option - name of the option.
      Returns:
      The Properties mapped by the option, never null even if the option doesn't exists.
      Since:
      1.5.0

    • getOptionProperties

      public Properties getOptionProperties(String optionName)
      Gets the map of values associated to the option. This is convenient for options specifying Java properties like -Dparam1=value1 -Dparam2=value2. The first argument of the option is the key, and the 2nd argument is the value. If the option has only one argument (-Dfoo) it is considered as a boolean flag and the value is "true".
      Parameters:
      optionName - name of the option.
      Returns:
      The Properties mapped by the option, never null even if the option doesn't exists.
      Since:
      1.2

    • getOptions

      public Option[] getOptions()
      Gets an array of the processed Options.
      Returns:
      an array of the processed Options.

    • getOptionValue

      public String getOptionValue(char optionChar)
      Gets the first argument, if any, of this option.
      Parameters:
      optionChar - the character name of the option.
      Returns:
      Value of the argument if option is set, and has an argument, otherwise null.

    • getOptionValue

      public String getOptionValue(char optionChar, String defaultValue)
      Gets the argument, if any, of an option.
      Parameters:
      optionChar - character name of the option
      defaultValue - is the default value to be returned if the option is not specified.
      Returns:
      Value of the argument if option is set, and has an argument, otherwise defaultValue.

    • getOptionValue

      public String getOptionValue(char optionChar, Supplier<String> defaultValue)
      Gets the argument, if any, of an option.
      Parameters:
      optionChar - character name of the option
      defaultValue - is a supplier for the default value to be returned if the option is not specified.
      Returns:
      Value of the argument if option is set, and has an argument, otherwise defaultValue.
      Since:
      1.7.0

    • getOptionValue

      public String getOptionValue(Option option)
      Gets the first argument, if any, of this option.
      Parameters:
      option - the option.
      Returns:
      Value of the argument if option is set, and has an argument, otherwise null.
      Since:
      1.5.0

    • getOptionValue

      public String getOptionValue(Option option, String defaultValue)
      Gets the first argument, if any, of an option.
      Parameters:
      option - the option.
      defaultValue - is the default value to be returned if the option is not specified.
      Returns:
      Value of the argument if option is set, and has an argument, otherwise defaultValue.
      Since:
      1.5.0

    • getOptionValue

      public String getOptionValue(Option option, Supplier<String> defaultValue)
      Gets the first argument, if any, of an option.
      Parameters:
      option - the option.
      defaultValue - is a supplier for the default value to be returned if the option is not specified.
      Returns:
      Value of the argument if option is set, and has an argument, otherwise defaultValue.
      Since:
      1.7.0

    • getOptionValue

      public String getOptionValue(OptionGroup optionGroup)
      Gets the first argument, if any, of this option group.
      Parameters:
      optionGroup - the option group.
      Returns:
      Value of the argument if option group is selected, and has an argument, otherwise null.
      Since:
      1.9.0

    • getOptionValue

      public String getOptionValue(OptionGroup optionGroup, String defaultValue)
      Gets the first argument, if any, of an option group.
      Parameters:
      optionGroup - the option group.
      defaultValue - is the default value to be returned if the option group is not selected.
      Returns:
      Value of the argument if option group is selected, and has an argument, otherwise defaultValue.
      Since:
      1.9.0

    • getOptionValue

      public String getOptionValue(OptionGroup optionGroup, Supplier<String> defaultValue)
      Gets the first argument, if any, of an option group.
      Parameters:
      optionGroup - the option group.
      defaultValue - is a supplier for the default value to be returned if the option group is not selected.
      Returns:
      Value of the argument if option group is selected, and has an argument, otherwise defaultValue.
      Since:
      1.9.0

    • getOptionValue

      public String getOptionValue(String optionName)
      Gets the first argument, if any, of this option.
      Parameters:
      optionName - the name of the option.
      Returns:
      Value of the argument if option is set, and has an argument, otherwise null.

    • getOptionValue

      public String getOptionValue(String optionName, String defaultValue)
      Gets the first argument, if any, of an option.
      Parameters:
      optionName - name of the option.
      defaultValue - is the default value to be returned if the option is not specified.
      Returns:
      Value of the argument if option is set, and has an argument, otherwise defaultValue.

    • getOptionValue

      public String getOptionValue(String optionName, Supplier<String> defaultValue)
      Gets the first argument, if any, of an option.
      Parameters:
      optionName - name of the option.
      defaultValue - is a supplier for the default value to be returned if the option is not specified.
      Returns:
      Value of the argument if option is set, and has an argument, otherwise defaultValue.
      Since:
      1.7.0

    • getOptionValues

      public String[] getOptionValues(char optionChar)
      Gets the array of values, if any, of an option.
      Parameters:
      optionChar - character name of the option.
      Returns:
      Values of the argument if option is set, and has an argument, otherwise null.

    • getOptionValues

      public String[] getOptionValues(Option option)
      Gets the array of values, if any, of an option.
      Parameters:
      option - the option.
      Returns:
      Values of the argument if option is set, and has an argument, otherwise null.
      Since:
      1.5.0

    • getOptionValues

      public String[] getOptionValues(OptionGroup optionGroup)
      Gets the array of values, if any, of an option group.
      Parameters:
      optionGroup - the option group.
      Returns:
      Values of the argument if option group is selected, and has an argument, otherwise null.
      Since:
      1.9.0

    • getOptionValues

      public String[] getOptionValues(String optionName)
      Gets the array of values, if any, of an option.
      Parameters:
      optionName - string name of the option.
      Returns:
      Values of the argument if option is set, and has an argument, otherwise null.

    • getParsedOptionValue

      public <T> T getParsedOptionValue(char optionChar) throws ParseException
      Gets a version of this Option converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      optionChar - the name of the option.
      Returns:
      the value parsed into a particular object or null if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.5.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(char optionChar, Supplier<T> defaultValue) throws ParseException
      Gets a version of this Option converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      optionChar - the name of the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the value parsed into a particular object or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.7.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(char optionChar, T defaultValue) throws ParseException
      Gets a version of this Option converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      optionChar - the name of the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the value parsed into a particular object or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.7.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(Option option) throws ParseException
      Gets a version of this Option converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      option - the option.
      Returns:
      the value parsed into a particular object or null if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.5.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(Option option, Supplier<T> defaultValue) throws ParseException
      Gets a version of this Option converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      option - the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the value parsed into a particular object or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.7.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(Option option, T defaultValue) throws ParseException
      Gets a version of this Option converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      option - the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the value parsed into a particular object or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.7.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(OptionGroup optionGroup) throws ParseException
      Gets a version of this OptionGroup converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      optionGroup - the option group.
      Returns:
      the value parsed into a particular object or null if no option in the OptionGroup is set.
      Throws:
      ParseException - if there are problems turning the selected option value into the desired type
      Since:
      1.9.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(OptionGroup optionGroup, Supplier<T> defaultValue) throws ParseException
      Gets a version of this OptionGroup converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      optionGroup - the option group.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the value parsed into a particular object or the defaultValue if no option in the OptionGroup is set.
      Throws:
      ParseException - if there are problems turning the selected option value into the desired type
      Since:
      1.9.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(OptionGroup optionGroup, T defaultValue) throws ParseException
      Gets a version of this OptionGroup converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      optionGroup - the option group.
      defaultValue - the default value to return if an option is not selected.
      Returns:
      the value parsed into a particular object or the defaultValue if no option in the OptionGroup is set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.9.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(String optionName) throws ParseException
      Gets a version of this Option converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      optionName - the name of the option.
      Returns:
      the value parsed into a particular object or null if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.2
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(String optionName, Supplier<T> defaultValue) throws ParseException
      Gets a version of this Option converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      optionName - the name of the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the value parsed into a particular object or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.7.0
      See Also:

    • getParsedOptionValue

      public <T> T getParsedOptionValue(String optionName, T defaultValue) throws ParseException
      Gets a version of this Option converted to a particular type.
      Type Parameters:
      T - The return type for the method.
      Parameters:
      optionName - the name of the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the value parsed into a particular object or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.7.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(char optionChar) throws ParseException
      Gets a version of this Option converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      optionChar - the name of the option.
      Returns:
      the values parsed into an array of objects or null if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(char optionChar, Supplier<T[]> defaultValue) throws ParseException
      Gets a version of this Option converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      optionChar - the name of the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the values parsed into an array of objects or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(char optionChar, T[] defaultValue) throws ParseException
      Gets a version of this Option converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      optionChar - the name of the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the values parsed into an array of objects or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(Option option) throws ParseException
      Gets a version of this Option converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      option - the option.
      Returns:
      the values parsed into an array of objects or null if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(Option option, Supplier<T[]> defaultValue) throws ParseException
      Gets a version of this Option converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      option - the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the values parsed into an array of objects or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(Option option, T[] defaultValue) throws ParseException
      Gets a version of this Option converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      option - the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the values parsed into an array of objects or the defaultValue if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(OptionGroup optionGroup) throws ParseException
      Gets a version of this OptionGroup converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      optionGroup - the option group.
      Returns:
      the values parsed into an array of objects or null if no option in the OptionGroup is set.
      Throws:
      ParseException - if there are problems turning the selected option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(OptionGroup optionGroup, Supplier<T[]> defaultValue) throws ParseException
      Gets a version of this OptionGroup converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      optionGroup - the option group.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the values parsed into an array of objects or null if no option in the OptionGroup is set.
      Throws:
      ParseException - if there are problems turning the selected option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(OptionGroup optionGroup, T[] defaultValue) throws ParseException
      Gets a version of this OptionGroup converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      optionGroup - the option group.
      defaultValue - the default value to return if an option is not selected.
      Returns:
      the values parsed into an array of objects or null if no option in the OptionGroup is set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(String optionName) throws ParseException
      Gets a version of this Option converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      optionName - the name of the option.
      Returns:
      the values parsed into an array of objects or null if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(String optionName, Supplier<T[]> defaultValue) throws ParseException
      Gets a version of this Option converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      optionName - the name of the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the values parsed into an array of objects or defaultValues if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • getParsedOptionValues

      public <T> T[] getParsedOptionValues(String optionName, T[] defaultValue) throws ParseException
      Gets a version of this Option converted to an array of a particular type.
      Type Parameters:
      T - The array type for the return value.
      Parameters:
      optionName - the name of the option.
      defaultValue - the default value to return if opt is not set.
      Returns:
      the values parsed into an array of objects or defaultValues if the option is not set.
      Throws:
      ParseException - if there are problems turning the option value into the desired type
      Since:
      1.10.0
      See Also:

    • hasOption

      public boolean hasOption(char optionChar)
      Tests to see if an option has been set.
      Parameters:
      optionChar - character name of the option.
      Returns:
      true if set, false if not.

    • hasOption

      public boolean hasOption(Option option)
      Tests to see if an option has been set.
      Parameters:
      option - the option to check.
      Returns:
      true if set, false if not.
      Since:
      1.5.0

    • hasOption

      public boolean hasOption(OptionGroup optionGroup)
      Tests to see if an option has been set.
      Parameters:
      optionGroup - the option group to check.
      Returns:
      true if set, false if not.
      Since:
      1.9.0

    • hasOption

      public boolean hasOption(String optionName)
      Tests to see if an option has been set.
      Parameters:
      optionName - Short name of the option.
      Returns:
      true if set, false if not.

    • iterator

      public Iterator<Option> iterator()
      Returns an iterator over the Option members of CommandLine.
      Returns:
      an Iterator over the processed Option members of this CommandLine.