Module com.adventure

Package com.adventure.commands

Class CmdHelp

java.lang.Object

com.adventure.commands.AbstractCommand

com.adventure.commands.CmdHelp

All Implemented Interfaces:

Command

public class CmdHelp
extends AbstractCommand

Command used to display possible command with descriptions.

Field Summary

Fields inherited from class com.adventure.commands.AbstractCommand

args, BUSY_WAITING_QUANTUM, context, inputStream, logger, shouldTerminate, writer

Constructor Summary

Constructors

Constructor	Description
CmdHelp()

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the command.
List<String>	getPossibleArgs()	Gets possible args for current command.

Methods inherited from class com.adventure.commands.AbstractCommand

askConfirmation, correctArgumentsNumber, disableDummyCommands, disableSaveAll, enableDummyCommands, getArgs, getContext, getInputStream, getWriter, kill, reEnableSaved, safeReadNext, safeReadNextLine, setArgs, setContext, setInputStream, setWriter

Methods inherited from class java.lang.Object

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

Constructor Details

CmdHelp

public CmdHelp()

Method Details

execute

public void execute()
             throws InterruptedException

Description copied from interface: Command

Executes the command.

Throws:

InterruptedException - Thrown if the command is interrupted (e.g. when kill is well implemented).

getPossibleArgs

public List<String> getPossibleArgs()

Description copied from class: AbstractCommand

Gets possible args for current command.

Specified by:

getPossibleArgs in interface Command

Specified by:

getPossibleArgs in class AbstractCommand

Returns:

A list of possible arguments for the command.