Module net.sourceforge.argparse4j
Class HelpArgumentAction
- java.lang.Object
-
- net.sourceforge.argparse4j.impl.action.HelpArgumentAction
-
- All Implemented Interfaces:
ArgumentAction
public class HelpArgumentAction extends java.lang.Object implements ArgumentAction
Argument action to print help message and exit program.
Please note that this
run(ArgumentParser, Argument, Map, String, Object)
always throws aHelpScreenException
exception after printing the help message.consumeArgument()
always returnsfalse
.
-
-
Constructor Summary
Constructors Constructor Description HelpArgumentAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
consumeArgument()
Returnstrue
if this action consumes argument.void
onAttach(Argument arg)
Called when ArgumentAction is added toArgument
usingArgument.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.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sourceforge.argparse4j.inf.ArgumentAction
run
-
-
-
-
Method Detail
-
run
public 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
Description copied from interface:ArgumentAction
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 inArgumentParserException
and give simple error message to explain what happened briefly.- Specified by:
run
in interfaceArgumentAction
- Parameters:
parser
- The parser.arg
- The argument this action attached to.attrs
- Map to store attributes.flag
- The actual option flag in command line ifarg
is a named arguments.null
ifarg
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
public boolean consumeArgument()
Description copied from interface:ArgumentAction
Returnstrue
if this action consumes argument. Otherwise returnsfalse
.- Specified by:
consumeArgument
in interfaceArgumentAction
- Returns:
true
orfalse
.
-
onAttach
public void onAttach(Argument arg)
Description copied from interface:ArgumentAction
Called when ArgumentAction is added toArgument
usingArgument.action(ArgumentAction)
.- Specified by:
onAttach
in interfaceArgumentAction
- Parameters:
arg
-Argument
object to which this object is added.
-
-