es.ucm.fdi.hysteria.console.command
Class HelpCommand

java.lang.Object
  es.ucm.fdi.hysteria.console.command.Command
      es.ucm.fdi.hysteria.console.command.HelpCommand

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class HelpCommand
extends Command
implements java.lang.Cloneable, java.io.Serializable

Author:

MiniSandor

See Also:

Serialized Form

Field Summary

protected Command	_com The command whose help is going to be printed
protected Parser	_parser The parser in order to delegate it the task of creating the help message

Fields inherited from class es.ucm.fdi.hysteria.console.command.Command

_config, _executed, _game, _parsed, _result, _successful

Constructor Summary

HelpCommand(Game theGame, Parser theParser)
HelpCommand constructor.

HelpCommand(Game theGame, Parser theParser, java.util.Properties config)

Method Summary

java.lang.Object	clone() Returns a clone of this command.
boolean	execute() Executes the command.
java.lang.String	getHelp() Creates a string with the information about the command.
boolean	parse(java.lang.String line) Tries to configure the command with the information contained in a string.
java.lang.String	toString()

Methods inherited from class es.ucm.fdi.hysteria.console.command.Command

getResult, hasResult, setConfig, setGame

Methods inherited from class java.lang.Object

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

Field Detail

_parser

protected Parser _parser

The parser in order to delegate it the task of creating the help message

_com

protected Command _com

The command whose help is going to be printed

Constructor Detail

HelpCommand

public HelpCommand(Game theGame,
                   Parser theParser)
            throws java.lang.IllegalArgumentException

HelpCommand constructor. Similar to its superclass

Parameters:

theGame - Reference to main Game

Throws:

java.lang.IllegalArgumentException

HelpCommand

public HelpCommand(Game theGame,
                   Parser theParser,
                   java.util.Properties config)
            throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

Method Detail

execute

public boolean execute()
                throws UnparsedCommandException

Description copied from class: Command

Executes the command.

Overrides:

execute in class Command

Throws:

UnparsedCommandException

getHelp

public java.lang.String getHelp()

Description copied from class: Command

Creates a string with the information about the command.

Specified by:

getHelp in class Command

Returns:

How to write this command

parse

public boolean parse(java.lang.String line)

Description copied from class: Command

Tries to configure the command with the information contained in a string.

Specified by:

parse in class Command

Parameters:

line - Order to parse

Returns:

Successfulness of the parse

toString

public java.lang.String toString()

Specified by:

toString in class Command

clone

public java.lang.Object clone()

Description copied from class: Command

Returns a clone of this command.

Overrides:

clone in class Command