Package net.sourceforge.argparse4j.inf

Interface ArgumentAction

All Known Implementing Classes:

AppendArgumentAction, AppendConstArgumentAction, CountArgumentAction, HelpArgumentAction, StoreArgumentAction, StoreConstArgumentAction, StoreFalseArgumentAction, StoreTrueArgumentAction, VersionArgumentAction

public interface ArgumentAction

This interface defines behavior of action when an argument is encountered at the command line.

Method Summary

Modifier and Type	Method	Description
boolean	consumeArgument()	Returns true if this action consumes argument.
void	onAttach(Argument arg)	Called when ArgumentAction is added to Argument using Argument.action(ArgumentAction).
void	run(ArgumentParser parser, Argument arg, java.util.Map<java.lang.String,java.lang.Object> attrs, java.lang.String flag, java.lang.Object value)	Executes this action.

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.

onAttach

void onAttach(Argument arg)

Called when ArgumentAction is added to Argument using Argument.action(ArgumentAction).

Parameters:

arg - Argument object to which this object is added.

consumeArgument

boolean consumeArgument()

Returns true if this action consumes argument. Otherwise returns false.

Returns:

true or false.