Interface ArgumentAction

    • Method Detail

      • run

        void run​(ArgumentParser parser,
                 Argument arg,
                 java.util.Map<java.lang.String,​java.lang.Object> attrs,
                 java.lang.String flag,
                 java.lang.Object value)
          throws ArgumentParserException

        Executes this action.

        If the objects derived from RuntimeException are thrown in this method because of invalid input from command line, subclass must catch these exceptions and wrap them in ArgumentParserException and give simple error message to explain what happened briefly.

        Parameters:
        parser - The parser.
        arg - The argument this action attached to.
        attrs - Map to store attributes.
        flag - The actual option flag in command line if arg is an optional arguments. null if arg is a positional argument.
        value - The attribute value. This may be null if this action does not consume any arguments.
        Throws:
        ArgumentParserException - If error occurred.
      • consumeArgument

        boolean consumeArgument()
        Returns true if this action consumes argument. Otherwise returns false.
        Returns:
        true or false.