Package org.springframework.shell.jline.command

Class History

java.lang.Object

org.springframework.shell.core.command.AbstractCommand

org.springframework.shell.jline.command.History

All Implemented Interfaces:

Command

public class History
extends AbstractCommand

A command that displays all previously run commands, optionally dumping them to a file readable by Script.

Author:

Eric Bottard, Mahmoud Ben Hassine

Nested Class Summary

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

Command.Builder

Constructor Summary

Constructors

Constructor	Description
History(org.jline.reader.History jLineHistory)

Method Summary

Modifier and Type	Method	Description
ExitStatus	doExecute(CommandContext commandContext)
String	getHelp()	Get the help text of the command.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

History

public History(org.jline.reader.History jLineHistory)

Method Details

getHelp

public String getHelp()

Description copied from interface: Command

Get the help text of the command. It is reported as the DESCRIPTION section of the detailed help message of the command, which is omitted when the text is empty. Unlike Command.getDescription(), which is a one liner shown in the list of available commands, the help text is meant to be a longer explanation of what the command does.

Specified by:

getHelp in interface Command

Overrides:

getHelp in class AbstractCommand

Returns:

the help text of the command, empty when the command does not define one

doExecute

public ExitStatus doExecute(CommandContext commandContext)
                     throws Exception

Specified by:

doExecute in class AbstractCommand

Throws:

Exception