Package software.amazon.smithy.cli.commands

Class SmithyCommand

java.lang.Object

software.amazon.smithy.cli.commands.SmithyCommand

All Implemented Interfaces:

Command

public class SmithyCommand
extends Object
implements Command

Nested Class Summary

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

Command.Env

Constructor Summary

Constructors

Constructor	Description
SmithyCommand()

Method Summary

Modifier and Type	Method	Description
int	execute(Arguments arguments, Command.Env env)	Executes the command using the provided arguments.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.cli.Command

getDocumentation

Constructor Details

SmithyCommand

public SmithyCommand()

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.

Specified by:

getName in interface Command

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.

Specified by:

getSummary in interface Command

Returns:

Returns the short help description.

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.

execute

public 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.