com.realtime.crossfire.jxclient.commands.AbstractCommand Class Reference

Inheritance diagram for com.realtime.crossfire.jxclient.commands.AbstractCommand:

Collaboration diagram for com.realtime.crossfire.jxclient.commands.AbstractCommand:

Public Member Functions
String	getCommandName ()
String	toString ()
Public Member Functions inherited from com.realtime.crossfire.jxclient.commands.Command
boolean	allArguments ()
void	execute (@NotNull String args)
String	getHelp ()

Protected Member Functions
	AbstractCommand (@NotNull final String commandName, @NotNull final CrossfireServerConnection crossfireServerConnection)
void	drawInfo (@NotNull final String message)
void	drawInfo (@NotNull final String message, final int color)
void	drawInfoError (@NotNull final String message)

Private Attributes
final String	commandName
final CrossfireServerConnection	crossfireServerConnection

Detailed Description

Abstract base class for Command implementations.

Author

Andreas Kirschbaum

Definition at line 33 of file AbstractCommand.java.

Constructor & Destructor Documentation

AbstractCommand()

com.realtime.crossfire.jxclient.commands.AbstractCommand.AbstractCommand ( @NotNull final String  commandName, @NotNull final CrossfireServerConnection  crossfireServerConnection  )

protected

Creates a new instance.

Parameters

commandName	the name of the command
crossfireServerConnection	the connection instance

Definition at line 52 of file AbstractCommand.java.

References com.realtime.crossfire.jxclient.commands.AbstractCommand.commandName, and com.realtime.crossfire.jxclient.commands.AbstractCommand.crossfireServerConnection.

Member Function Documentation

drawInfo() [1/2]

void com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfo ( @NotNull final String  message )

protected

Displays a regular output message.

Parameters

message

the message

Definition at line 61 of file AbstractCommand.java.

References com.realtime.crossfire.jxclient.server.crossfire.CrossfireDrawinfoListener.NDI_BLACK.

Referenced by com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfoError(), com.realtime.crossfire.jxclient.commands.DebugMessagesCommand.execute(), com.realtime.crossfire.jxclient.commands.BindingsCommand.execute(), com.realtime.crossfire.jxclient.commands.ScriptsCommand.execute(), com.realtime.crossfire.jxclient.commands.HelpCommand.execute(), com.realtime.crossfire.jxclient.commands.ScreenshotCommand.execute(), and com.realtime.crossfire.jxclient.commands.ShortcutCommand.listSlots().

Here is the caller graph for this function:

drawInfo() [2/2]

void com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfo ( @NotNull final String  message, final int  color  )

protected

Displays a message.

Parameters

message	the message
color	the color code

Definition at line 78 of file AbstractCommand.java.

References com.realtime.crossfire.jxclient.commands.AbstractCommand.crossfireServerConnection, and com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.drawInfo().

Here is the call graph for this function:

drawInfoError()

void com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfoError ( @NotNull final String  message )

protected

Displays an error message.

Parameters

message

the error message

Definition at line 69 of file AbstractCommand.java.

References com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfo(), and com.realtime.crossfire.jxclient.server.crossfire.CrossfireDrawinfoListener.NDI_RED.

Referenced by com.realtime.crossfire.jxclient.commands.ScriptkillCommand.execute(), com.realtime.crossfire.jxclient.commands.ScriptCommand.execute(), com.realtime.crossfire.jxclient.commands.UnbindCommand.execute(), com.realtime.crossfire.jxclient.commands.DebugMessagesCommand.execute(), com.realtime.crossfire.jxclient.commands.ClearCommand.execute(), com.realtime.crossfire.jxclient.commands.ScriptkillallCommand.execute(), com.realtime.crossfire.jxclient.commands.ExecCommand.execute(), com.realtime.crossfire.jxclient.commands.ScripttellCommand.execute(), com.realtime.crossfire.jxclient.commands.SetCommand.execute(), com.realtime.crossfire.jxclient.commands.AgainCommand.execute(), com.realtime.crossfire.jxclient.commands.BindCommand.execute(), com.realtime.crossfire.jxclient.commands.ScreenshotCommand.execute(), and com.realtime.crossfire.jxclient.commands.ShortcutCommand.parseKey().

Here is the call graph for this function:

Here is the caller graph for this function:

getCommandName()

String com.realtime.crossfire.jxclient.commands.AbstractCommand.getCommandName

(

)

Returns the name of the command.

Returns

the name

Implements com.realtime.crossfire.jxclient.commands.Command.

Definition at line 84 of file AbstractCommand.java.

References com.realtime.crossfire.jxclient.commands.AbstractCommand.commandName.

toString()

String com.realtime.crossfire.jxclient.commands.AbstractCommand.toString

(

)

Definition at line 90 of file AbstractCommand.java.

References com.realtime.crossfire.jxclient.commands.AbstractCommand.commandName.

Member Data Documentation

commandName

final String com.realtime.crossfire.jxclient.commands.AbstractCommand.commandName

private

The name of the command.

Definition at line 39 of file AbstractCommand.java.

Referenced by com.realtime.crossfire.jxclient.commands.AbstractCommand.AbstractCommand(), com.realtime.crossfire.jxclient.commands.AbstractCommand.getCommandName(), com.realtime.crossfire.jxclient.commands.TestCommand.TestCommand(), and com.realtime.crossfire.jxclient.commands.AbstractCommand.toString().

crossfireServerConnection

final CrossfireServerConnection com.realtime.crossfire.jxclient.commands.AbstractCommand.crossfireServerConnection

private

The connection instance.

Definition at line 45 of file AbstractCommand.java.

Referenced by com.realtime.crossfire.jxclient.commands.AbstractCommand.AbstractCommand(), com.realtime.crossfire.jxclient.commands.AgainCommand.AgainCommand(), com.realtime.crossfire.jxclient.commands.BindCommand.BindCommand(), com.realtime.crossfire.jxclient.commands.BindingsCommand.BindingsCommand(), com.realtime.crossfire.jxclient.commands.ClearCommand.ClearCommand(), com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfo(), com.realtime.crossfire.jxclient.commands.ExecCommand.ExecCommand(), com.realtime.crossfire.jxclient.commands.HelpCommand.HelpCommand(), com.realtime.crossfire.jxclient.commands.ScreenshotCommand.ScreenshotCommand(), com.realtime.crossfire.jxclient.commands.ScriptCommand.ScriptCommand(), com.realtime.crossfire.jxclient.commands.ScriptkillallCommand.ScriptkillallCommand(), com.realtime.crossfire.jxclient.commands.ScriptkillCommand.ScriptkillCommand(), com.realtime.crossfire.jxclient.commands.ScriptsCommand.ScriptsCommand(), com.realtime.crossfire.jxclient.commands.ScripttellCommand.ScripttellCommand(), com.realtime.crossfire.jxclient.commands.SetCommand.SetCommand(), com.realtime.crossfire.jxclient.commands.ShortcutCommand.ShortcutCommand(), com.realtime.crossfire.jxclient.commands.TestCommand.TestCommand(), and com.realtime.crossfire.jxclient.commands.UnbindCommand.UnbindCommand().

---

The documentation for this class was generated from the following file:

• src/gui/src/main/java/com/realtime/crossfire/jxclient/commands/AbstractCommand.java