Package software.amazon.smithy.cli.commands

Class SelectCommand

java.lang.Object

software.amazon.smithy.cli.commands.SelectCommand

All Implemented Interfaces:

Command

public final class SelectCommand
extends Object

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.smithy.cli.Command

Command.Env

Constructor Summary

Constructors

Constructor	Description
SelectCommand(String parentCommandName)

Method Summary

Modifier and Type	Method	Description
protected List<ArgumentReceiver>	createArgumentReceivers()	Creates argument receivers for the command.
final int	execute(Arguments arguments, Command.Env env)	Executes the command using the provided arguments.
String	getDocumentation(CliPrinter printer)	Gets the long description of the command.
String	getName()	Gets the name of the command.
String	getSummary()	Gets a short summary of the command that's shown in the main help.
void	printHelp(Arguments arguments, CliPrinter printer)	Prints help output.
protected int	run(Arguments arguments, Command.Env env, List<String> models)	Run the non-help command after all arguments have been parsed.

Methods inherited from class java.lang.Object

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

Constructor Details

SelectCommand

public SelectCommand(String parentCommandName)

Method Details

getName

public String getName()

Description copied from interface: Command

Gets the name of the command.

The returned name should contain no spaces or special characters.

Returns:

Returns the command name.

getSummary

public String getSummary()

Description copied from interface: Command

Gets a short summary of the command that's shown in the main help.

Returns:

Returns the short help description.

getDocumentation

public String getDocumentation(CliPrinter printer)

Description copied from interface: Command

Gets the long description of the command.

Parameters:

printer - CliPrinter used in case formatting is needed via CliPrinter.style(String, Style...).

Returns:

Returns the long description.

createArgumentReceivers

protected List<ArgumentReceiver> createArgumentReceivers()

Creates argument receivers for the command.

Returns:

Returns the parsed positional arguments.

run

protected int run(Arguments arguments,
 Command.Env env,
 List<String> models)

Run the non-help command after all arguments have been parsed.

Parameters:

arguments - Arguments to evaluate.

env - CLI environment settings.

models - Parsed positional arguments.

Returns:

Returns the exit code.

execute

public final int execute(Arguments arguments,
 Command.Env env)

Description copied from interface: Command

Executes the command using the provided arguments.

Specified by:

execute in interface Command

Parameters:

arguments - CLI arguments.

env - CLI environment settings like stdout, stderr, etc.

Returns:

Returns the exit code.

printHelp

public void printHelp(Arguments arguments,
 CliPrinter printer)

Description copied from interface: Command

Prints help output.

Specified by:

printHelp in interface Command

Parameters:

arguments - Arguments that have been parsed so far.

printer - Where to write help.