org.springframework.boot.cli.command

Class ScriptCommand

java.lang.Object

org.springframework.boot.cli.command.ScriptCommand

All Implemented Interfaces:

Command

public class ScriptCommand
extends Object
implements Command

Command to run a Groovy script.

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
ScriptCommand(String script)

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.
protected Object	getMain()
String	getName() Returns the name of the command.
String	getUsageHelp() Returns usage help for the command.
void	run(String... args) Run the command.
void	setPaths(String[] paths) Paths to search for script files.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptCommand

public ScriptCommand(String script)

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

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

run

public void run(String... args)
         throws Exception

Description copied from interface: Command

Run the command.

Specified by:

run in interface Command

Parameters:

args - command arguments (this will not include the command itself)

Throws:

Exception

setPaths

public void setPaths(String[] paths)

Paths to search for script files.

Parameters:

paths - the paths to set

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

getMain

protected Object getMain()