Class StoreFalseArgumentAction
- All Implemented Interfaces:
ArgumentAction
Argument action to store value false
.
In addition, it creates default value of true
.
onAttach(Argument)
calls Argument.setDefault(Object)
with
true
. consumeArgument()
always returns false
.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returnstrue
if this action consumes argument.void
Called when ArgumentAction is added toArgument
usingArgument.action(ArgumentAction)
.void
Executes this action.void
run
(ArgumentParser parser, Argument arg, Map<String, Object> attrs, String flag, Object value, Consumer<Object> valueSetter) Executes this action.
-
Constructor Details
-
StoreFalseArgumentAction
public StoreFalseArgumentAction()
-
-
Method Details
-
run
public void run(ArgumentParser parser, Argument arg, Map<String, Object> attrs, String flag, Object value) 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.
-
run
public void run(ArgumentParser parser, Argument arg, Map<String, Object> attrs, String flag, Object value, Consumer<Object> valueSetter) 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
- The current map of attributes. Implementations may read from this map, but may not change it. Implementations must call thevalueSetter
with the actual value to be set.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.valueSetter
- The consumer that will set the actual value determined by this action in the result.
-
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
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.
-