Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.commands.AbstractCommand Class Reference

Crossfire JXClient, Trunk R20561

Abstract base class for Command implementations. More...

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

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

Public Member Functions
String	getCommandName ()
	Returns the name of the command. Returns the name More...

String	toString ()

Public Member Functions inherited from com.realtime.crossfire.jxclient.commands.Command
boolean	allArguments ()
	Returns whether all remaining commands should be included as arguments. More...

void	execute (@NotNull String args)
	Executes the command with the given arguments. More...

Protected Member Functions
	AbstractCommand (@NotNull final String commandName, @NotNull final CrossfireServerConnection crossfireServerConnection)
	Creates a new instance. More...

void	drawInfo (@NotNull final String message)
	Displays a regular output message. More...

void	drawInfo (@NotNull final String message, final int color)
	Displays a message. More...

void	drawInfoError (@NotNull final String message)
	Displays an error message. More...

Private Attributes
final String	commandName
	The name of the command. More...

final CrossfireServerConnection	crossfireServerConnection
	The connection instance. More...

Detailed Description

Abstract base class for Command implementations.

Author: Andreas Kirschbaum

Definition at line 32 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 51 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 60 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.BindingsCommand.execute(), com.realtime.crossfire.jxclient.commands.DebugMessagesCommand.execute(), com.realtime.crossfire.jxclient.commands.ScriptsCommand.execute(), and com.realtime.crossfire.jxclient.commands.ScreenshotCommand.execute().

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 77 of file AbstractCommand.java.

References 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 68 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.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.ScriptkillCommand.execute(), com.realtime.crossfire.jxclient.commands.ExecCommand.execute(), com.realtime.crossfire.jxclient.commands.SetCommand.execute(), com.realtime.crossfire.jxclient.commands.ScripttellCommand.execute(), com.realtime.crossfire.jxclient.commands.AgainCommand.execute(), com.realtime.crossfire.jxclient.commands.BindCommand.execute(), and com.realtime.crossfire.jxclient.commands.ScreenshotCommand.execute().

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 86 of file AbstractCommand.java.

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

◆ toString()

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

Definition at line 95 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 38 of file AbstractCommand.java.

Referenced by com.realtime.crossfire.jxclient.commands.AbstractCommand.AbstractCommand(), com.realtime.crossfire.jxclient.commands.AbstractCommand.getCommandName(), 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 44 of file AbstractCommand.java.

Referenced by com.realtime.crossfire.jxclient.commands.AbstractCommand.AbstractCommand().

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

crossfire-code/jxclient/trunk/src/gui/src/main/java/com/realtime/crossfire/jxclient/commands/AbstractCommand.java