public class BooleanHandler extends java.lang.Object implements CmdOptionHandler
Boolean
(or boolean
) field
or method.
Evaluates the argument to true
if it is "true", "on" or "1".Constructor and Description |
---|
BooleanHandler() |
BooleanHandler(java.lang.String[] trueWords,
java.lang.String[] falseWords,
boolean caseSensitive)
If the list of falseWords is empty or
null , any words not in
trueWords is considered as false. |
Modifier and Type | Method and Description |
---|---|
void |
applyParams(java.lang.Object config,
java.lang.reflect.AccessibleObject element,
java.lang.String[] args,
java.lang.String optionName)
Apply the option and it arguments (if any) to the field or method
representing the option.
|
boolean |
canHandle(java.lang.reflect.AccessibleObject element,
int argCount)
Return
true if the field or method (element )
with the given number of arguments (argCount ) can be handled
by this handler. |
public BooleanHandler()
public BooleanHandler(java.lang.String[] trueWords, java.lang.String[] falseWords, boolean caseSensitive)
null
, any words not in
trueWords is considered as false.trueWords
- falseWords
- caseSensitive
- public boolean canHandle(java.lang.reflect.AccessibleObject element, int argCount)
CmdOptionHandler
true
if the field or method (element
)
with the given number of arguments (argCount
) can be handled
by this handler.canHandle
in interface CmdOptionHandler
element
- The field or method that represents an command line option.argCount
- The number or arguments the command line option supports.true
if the option can be parsed and applied by this
handler.public void applyParams(java.lang.Object config, java.lang.reflect.AccessibleObject element, java.lang.String[] args, java.lang.String optionName) throws CmdOptionHandlerException
CmdOptionHandler
applyParams
in interface CmdOptionHandler
config
- The object containing the field or element to which the parsed
values should be applied.element
- The element itself (field or method) to apply to.args
- The parsed arguments of the option.optionName
- The actual name of the currently handled option. This is only
required to create good error messages.CmdOptionHandlerException
- When the argument can not be applied to the config object.