net.morimekta.console.args

Class Argument

java.lang.Object

net.morimekta.console.args.BaseArgument

net.morimekta.console.args.Argument

public class Argument
extends BaseArgument

An argument is a non-optioned CLI argument. Instead of having to match the option name, it may use a predicate to test the value before applying.

Constructor Summary

Constructors

Constructor and Description
Argument(String name, String usage, Consumer<String> consumer) Create a default required argument.
Argument(String name, String usage, Consumer<String> consumer, String defaultValue) Create a default optional argument with default value.
Argument(String name, String usage, Consumer<String> consumer, String defaultValue, Predicate<String> predicate, boolean repeated, boolean required, boolean hidden) Create an argument instance.

Method Summary

Modifier and Type	Method and Description
int	apply(ArgumentList args) Try to apply to the argument.
String	getPrefix() Prefix part of the usage usage message.
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 java.lang.Object

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

Constructor Detail

Argument

public Argument(String name,
                String usage,
                Consumer<String> consumer)

Create a default required argument.

Parameters:

name - The name of the argument.

usage - The argument usage description.

consumer - The argument consumer.

Argument

public Argument(String name,
                String usage,
                Consumer<String> consumer,
                String defaultValue)

Create a default optional argument with default value.

Parameters:

name - The name of the argument.

usage - The argument usage description.

consumer - The argument consumer.

defaultValue - The default value.

Argument

public Argument(String name,
                String usage,
                Consumer<String> consumer,
                String defaultValue,
                Predicate<String> predicate,
                boolean repeated,
                boolean required,
                boolean hidden)

Create an argument instance.

Parameters:

name - The name of the argument.

usage - The argument usage description.

consumer - The argument consumer.

defaultValue - The default value.

predicate - A predicate to check if the argument should try to consume the value.

repeated - If the argument is repeated.

required - If the argument is required.

hidden - If the argument is hidden.

Method Detail

getSingleLineUsage

public String getSingleLineUsage()

Description copied from class: BaseArgument

Get the argument's single line usage string.

Specified by:

getSingleLineUsage in class BaseArgument

Returns:

The single-line usage string.

getPrefix

public String getPrefix()

Description copied from class: BaseArgument

Prefix part of the usage usage message.

Specified by:

getPrefix in class BaseArgument

Returns:

The usage prefix.

validate

public void validate()
              throws ArgumentException

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

Throws:

ArgumentException

apply

public int apply(ArgumentList args)

Description copied from class: BaseArgument

Try to apply to the argument. The method shoud return 0 if the argument is rejected, otherwise the number of argument strings that was consumed.

Specified by:

apply in class BaseArgument

Parameters:

args - The argument list.

Returns:

The number of args consumed.