Package net.morimekta.console.args

Class Flag

java.lang.Object

net.morimekta.console.args.BaseArgument

net.morimekta.console.args.BaseOption

net.morimekta.console.args.Flag

public class Flag
extends BaseOption

Similar to Option, but without any value argument. Can only toggle boolean values.

Constructor Summary

Constructors

Constructor	Description
Flag(java.lang.String name, java.lang.String shortNames, java.lang.String usage, java.util.function.Consumer<java.lang.Boolean> setter)
Flag(java.lang.String name, java.lang.String shortNames, java.lang.String usage, java.util.function.Consumer<java.lang.Boolean> setter, java.lang.Boolean defaultValue)
Flag(java.lang.String name, java.lang.String shortNames, java.lang.String usage, java.util.function.Consumer<java.lang.Boolean> setter, java.lang.Boolean defaultValue, boolean hidden)
Flag(java.lang.String name, java.lang.String shortNames, java.lang.String usage, java.util.function.Consumer<java.lang.Boolean> setter, java.lang.Boolean defaultValue, java.lang.String negateName)
Flag(java.lang.String name, java.lang.String shortNames, java.lang.String usage, java.util.function.Consumer<java.lang.Boolean> setter, java.lang.Boolean defaultValue, java.lang.String negateName, boolean hidden)

Method Summary

Modifier and Type	Method	Description
int	apply(ArgumentList args)	Parse the argument list, including the argument string that triggered the call.
int	applyShort(java.lang.String opts, ArgumentList args)	When handling a list of short options, except for the last short option.
java.lang.String	getNegateName()	The alternative (negating) long name for the flag.
java.lang.String	getSingleLineUsage()	Get the argument's single line usage string.
void	validate()	Called on all the arguments after the parsing is done to validate if all requirements have been passed.

Methods inherited from class net.morimekta.console.args.BaseArgument

getDefaultValue, getName, getUsage, isHidden, isRepeated, isRequired

Methods inherited from class net.morimekta.console.args.BaseOption

getMetaVar, getPrefix, getShortNames, nameOrShort

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Flag

public Flag(java.lang.String name,
            java.lang.String shortNames,
            java.lang.String usage,
            java.util.function.Consumer<java.lang.Boolean> setter)

Flag

public Flag(java.lang.String name,
            java.lang.String shortNames,
            java.lang.String usage,
            java.util.function.Consumer<java.lang.Boolean> setter,
            java.lang.Boolean defaultValue)

Flag

public Flag(java.lang.String name,
            java.lang.String shortNames,
            java.lang.String usage,
            java.util.function.Consumer<java.lang.Boolean> setter,
            java.lang.Boolean defaultValue,
            java.lang.String negateName)

Flag

public Flag(java.lang.String name,
            java.lang.String shortNames,
            java.lang.String usage,
            java.util.function.Consumer<java.lang.Boolean> setter,
            java.lang.Boolean defaultValue,
            boolean hidden)

Flag

public Flag(java.lang.String name,
            java.lang.String shortNames,
            java.lang.String usage,
            java.util.function.Consumer<java.lang.Boolean> setter,
            java.lang.Boolean defaultValue,
            java.lang.String negateName,
            boolean hidden)

Method Detail

getNegateName

public java.lang.String getNegateName()

The alternative (negating) long name for the flag.

Returns:

The negating name.

getSingleLineUsage

public java.lang.String getSingleLineUsage()

Description copied from class: BaseArgument

Get the argument's single line usage string.

Overrides:

getSingleLineUsage in class BaseOption

Returns:

The single-line usage string.

validate

public void validate()

Description copied from class: BaseArgument

Called on all the arguments after the parsing is done to validate if all requirements have been passed. Should throw an ArgumentException if is did not validate with the appropriate error message.

Specified by:

validate in class BaseArgument

applyShort

public int applyShort(java.lang.String opts,
                      ArgumentList args)

Description copied from class: BaseOption

When handling a list of short options, except for the last short option.

Specified by:

applyShort in class BaseOption

Parameters:

opts - The remaining characters of the short opt list.

args - The list of arguments including the short opt list.

Returns:

The number of arguments consumed. If 0 is returned, will handle as the short option char was the only thing being consumed.

apply

public int apply(ArgumentList args)

Description copied from class: BaseOption

Parse the argument list, including the argument string that triggered the call. And handle it's value or values.

Specified by:

apply in class BaseOption

Parameters:

args - The list of arguments.

Returns:

The number of arguments consumed.