Class OneArgumentOptionHandler<T>

java.lang.Object
org.kohsuke.args4j.spi.OptionHandler<T>
org.kohsuke.args4j.spi.OneArgumentOptionHandler<T>
Type Parameters:
T - Type of the Setter-class
Direct Known Subclasses:
ByteOptionHandler, CharOptionHandler, DoubleOptionHandler, FileOptionHandler, FloatOptionHandler, InetAddressOptionHandler, IntOptionHandler, LongOptionHandler, PathOptionHandler, ShortOptionHandler, UuidOptionHandler

public abstract class OneArgumentOptionHandler<T> extends OptionHandler<T>
OptionHandler which handles an option with exactly one argument, like "-foo bar".
Since:
2.0.9
  • Constructor Details

  • Method Details

    • getDefaultMetaVariable

      public String getDefaultMetaVariable()
      Description copied from class: OptionHandler
      Gets the default meta variable name used to print the usage screen. The value returned by this method can be a reference in the ResourceBundle, if one was passed to CmdLineParser.
      Specified by:
      getDefaultMetaVariable in class OptionHandler<T>
      Returns:
      null to hide a meta variable.
    • parseArguments

      public int parseArguments(Parameters params) throws CmdLineException
      Description copied from class: OptionHandler
      Called if the option that this owner recognizes is found.
      Specified by:
      parseArguments in class OptionHandler<T>
      Parameters:
      params - The rest of the arguments. This method can use this object to access the arguments of the option if necessary. The object is valid only during the method call.
      Returns:
      The number of arguments consumed. (For example, returns 0 if this option doesn't take any parameters.)
      Throws:
      CmdLineException
    • parse

      protected abstract T parse(String argument) throws NumberFormatException, CmdLineException
      Parses a string to a real value of Type <T>.
      Parameters:
      argument - String value to parse
      Returns:
      the parsed value
      Throws:
      NumberFormatException - if parsing is not possible
      CmdLineException - if the parsing encounters a failure that should be reported to the user.