org.springframework.boot.cli.command

Class AbstractCommand

java.lang.Object

org.springframework.boot.cli.command.AbstractCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

OptionParsingCommand, VersionCommand

public abstract class AbstractCommand
extends Object
implements Command

Abstract Command implementation.

Author:

Phillip Webb, Dave Syer

Constructor Summary

Constructors

Constructor and Description
AbstractCommand(String name, String description) Create a new AbstractCommand instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns a description of the command.
String	getHelp() Gets full help text for the command, e.g.
String	getName() Returns the name of the command.
String	getUsageHelp() Returns usage help for the command.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.cli.Command

run

Constructor Detail

AbstractCommand

public AbstractCommand(String name,
               String description)

Create a new AbstractCommand instance.

Parameters:

name - the name of the command

description - the command description

Method Detail

getName

public String getName()

Description copied from interface: Command

Returns the name of the command.

Specified by:

getName in interface Command

getDescription

public String getDescription()

Description copied from interface: Command

Returns a description of the command.

Specified by:

getDescription in interface Command

getUsageHelp

public String getUsageHelp()

Description copied from interface: Command

Returns usage help for the command. This should be a simple one-line string describing basic usage. e.g. '[options] <file>'. Do not include the name of the command in this string.

Specified by:

getUsageHelp in interface Command

getHelp

public String getHelp()

Description copied from interface: Command

Gets full help text for the command, e.g. a longer description and one line per option.

Specified by:

getHelp in interface Command