net.morimekta.console.args

Class SubCommandSet<SubCommandDef>

java.lang.Object

net.morimekta.console.args.BaseArgument

net.morimekta.console.args.SubCommandSet<SubCommandDef>

public class SubCommandSet<SubCommandDef>
extends BaseArgument

TODO(morimekta): Make a real class description.

Constructor Summary

Constructors

Constructor and Description
SubCommandSet(String name, String usage, Consumer<SubCommandDef> consumer)

Method Summary

Modifier and Type	Method and Description
SubCommandSet	add(SubCommand<SubCommandDef> subCommand) Add a sub-command to the sub-command-set.
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

SubCommandSet

public SubCommandSet(String name,
                     String usage,
                     Consumer<SubCommandDef> consumer)

Method Detail

add

public SubCommandSet add(SubCommand<SubCommandDef> subCommand)

Add a sub-command to the sub-command-set.

Parameters:

subCommand - The sub-command to add.

Returns:

The sub-command-set.

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.