Class ExplicitBooleanOptionHandler

java.lang.Object
org.kohsuke.args4j.spi.OptionHandler<Boolean>
org.kohsuke.args4j.spi.ExplicitBooleanOptionHandler

public class ExplicitBooleanOptionHandler extends OptionHandler<Boolean>
Boolean OptionHandler that (unlike the standard BooleanOptionHandler allows values to be set to false explicitly (using e.g. '-myOpt false') rather than only returning false when the option is omitted.
  • Field Details

    • ACCEPTABLE_VALUES

      private static final Map<String,Boolean> ACCEPTABLE_VALUES
  • Constructor Details

  • Method Details

    • 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<Boolean>
      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
    • getBoolean

      private Boolean getBoolean(String parameter) throws CmdLineException
      Throws:
      CmdLineException
    • 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<Boolean>
      Returns:
      null to hide a meta variable.