com.realtime.crossfire.jxclient.commands

Class HelpCommand

java.lang.Object

com.realtime.crossfire.jxclient.commands.AbstractCommand

com.realtime.crossfire.jxclient.commands.HelpCommand

All Implemented Interfaces:

Command

public class HelpCommand
extends AbstractCommand

Implements the command "help". It shows help for a command.

Constructor Summary

Constructors

Constructor and Description
HelpCommand(@NotNull CrossfireServerConnection crossfireServerConnection, @NotNull CommandQueue commandQueue, @NotNull Commands commands) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	allArguments() Returns whether all remaining commands should be included as arguments.
void	execute(@NotNull java.lang.String args) Executes the command with the given arguments.
@NotNull java.lang.String	getHelp() Returns the help text for this command.

Methods inherited from class com.realtime.crossfire.jxclient.commands.AbstractCommand

drawInfo, drawInfo, drawInfoError, getCommandName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommand

public HelpCommand(@NotNull
                   @NotNull CrossfireServerConnection crossfireServerConnection,
                   @NotNull
                   @NotNull CommandQueue commandQueue,
                   @NotNull
                   @NotNull Commands commands)

Creates a new instance.

Parameters:

crossfireServerConnection - the connection instance

commandQueue - the command queue instance for sending "help" commands to the server

commands - all defined client-sided commands

Method Detail

allArguments

public boolean allArguments()

Description copied from interface: Command

Returns whether all remaining commands should be included as arguments.

Returns:

whether all remaining commands should be included as arguments

execute

public void execute(@NotNull
                    @NotNull java.lang.String args)

Description copied from interface: Command

Executes the command with the given arguments.

Parameters:

args - the command arguments

getHelp

@NotNull
public @NotNull java.lang.String getHelp()

Description copied from interface: Command

Returns the help text for this command.

Returns:

the help text