Package org.springframework.shell.core.command

Class Clear

java.lang.Object

org.springframework.shell.core.command.Clear

All Implemented Interfaces:

Command

public class Clear
extends Object
implements Command

ANSI console clear command.

Author:

Eric Bottard, Janne Valkealahti, 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
Clear()

Method Summary

Modifier and Type	Method	Description
ExitStatus	execute(CommandContext commandContext)	Execute the command within the given context.
String	getDescription()	Get a short description of the command.
String	getGroup()	Get the group of 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.shell.core.command.Command

getAliases, getAvailabilityProvider, getCompletionProvider, getHelp, getName, getOptions, isHidden

Constructor Details

Clear

public Clear()

Method Details

getDescription

public String getDescription()

Description copied from interface: Command

Get a short description of the command.

Specified by:

getDescription in interface Command

Returns:

the description of the command

getGroup

public String getGroup()

Description copied from interface: Command

Get the group of the command.

Specified by:

getGroup in interface Command

Returns:

the group of the command

execute

public ExitStatus execute(CommandContext commandContext)
                   throws Exception

Description copied from interface: Command

Execute the command within the given context.

Specified by:

execute in interface Command

Parameters:

commandContext - the context of the command

Returns:

the exit status of the command

Throws:

Exception