net.morimekta.console.args

Class SubCommand<SubCommandDef>

java.lang.Object

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

Type Parameters:

SubCommandDef - The sub-command instance type.

public class SubCommand<SubCommandDef>
extends Object

Sub command base class.

Constructor Summary

Constructors

Constructor and Description
SubCommand(String name, String usage, boolean hidden, Supplier<SubCommandDef> instanceFactory, Function<SubCommandDef,ArgumentParser> parserFactory, Iterable<String> aliases)
SubCommand(String name, String usage, boolean hidden, Supplier<SubCommandDef> instanceFactory, Function<SubCommandDef,ArgumentParser> parserFactory, String... aliases)

Method Summary

Modifier and Type	Method and Description
List<String>	getAliases() Get the list of sub-command aliases.
ArgumentParser	getArgumentParser(SubCommandDef instance) Get the sub-commands internal argument argumentParser initializes with it's own options.
String	getName() The sub-command name.
String	getUsage() The basic usage description.
boolean	isHidden() If the sub-command is hidden by default.
SubCommandDef	newInstance() Instantiate the selected commands implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubCommand

public SubCommand(String name,
                  String usage,
                  boolean hidden,
                  Supplier<SubCommandDef> instanceFactory,
                  Function<SubCommandDef,ArgumentParser> parserFactory,
                  String... aliases)

SubCommand

public SubCommand(String name,
                  String usage,
                  boolean hidden,
                  Supplier<SubCommandDef> instanceFactory,
                  Function<SubCommandDef,ArgumentParser> parserFactory,
                  Iterable<String> aliases)

Method Detail

getName

public String getName()

The sub-command name.

Returns:

The name.

getUsage

public String getUsage()

The basic usage description.

Returns:

The usage description.

isHidden

public boolean isHidden()

If the sub-command is hidden by default.

Returns:

True if hidden.

getAliases

public List<String> getAliases()

Get the list of sub-command aliases.

Returns:

The aliases.

newInstance

public SubCommandDef newInstance()

Instantiate the selected commands implementation.

Returns:

The new sub-command isntance.

getArgumentParser

public ArgumentParser getArgumentParser(SubCommandDef instance)

Get the sub-commands internal argument argumentParser initializes with it's own options.

Parameters:

instance - The instance to make parser for.

Returns:

The argument argumentParser.