Package org.springframework.shell.core.command

Class Script

java.lang.Object

org.springframework.shell.core.command.AbstractCommand

org.springframework.shell.core.command.Script

All Implemented Interfaces:

Command

public class Script
extends AbstractCommand

A command that can read and execute other commands from a file.

Author:

Eric Bottard, Janne Valkealahti, Mahmoud Ben Hassine, David Pilar

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.shell.core.command.Command

Command.Builder

Constructor Summary

Constructors

Constructor	Description
Script(CommandRegistry commandRegistry)

Method Summary

Modifier and Type	Method	Description
ExitStatus	doExecute(CommandContext commandContext)
String	getHelp()	Get the help text of the command.
List<CommandOption>	getOptions()	Get the options of the command.
void	setCommandParser(CommandParser commandParser)	Set the command parser to use to parse commands in the script.

Methods inherited from class org.springframework.shell.core.command.AbstractCommand

equals, execute, getAliases, getAvailabilityProvider, getCompletionProvider, getDescription, getExitStatusExceptionMapper, getGroup, getName, hashCode, isHelp, isHidden, println, setAliases, setAvailabilityProvider, setCompletionProvider, setExitStatusExceptionMapper, setOptions

Methods inherited from class java.lang.Object

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

Constructor Details

Script

public Script(CommandRegistry commandRegistry)

Method Details

getHelp

public String getHelp()

Description copied from interface: Command

Get the help text of the command.

Specified by:

getHelp in interface Command

Overrides:

getHelp in class AbstractCommand

Returns:

the help text of the command

getOptions

public List<CommandOption> getOptions()

Description copied from interface: Command

Get the options of the command.

Specified by:

getOptions in interface Command

Overrides:

getOptions in class AbstractCommand

Returns:

the options of the command

doExecute

public ExitStatus doExecute(CommandContext commandContext)
                     throws Exception

Specified by:

doExecute in class AbstractCommand

Throws:

Exception

setCommandParser

public void setCommandParser(CommandParser commandParser)

Set the command parser to use to parse commands in the script.

Parameters:

commandParser - the command parser to set