com.realtime.crossfire.jxclient.commands

Class ClearCommand

java.lang.Object

com.realtime.crossfire.jxclient.commands.AbstractCommand

com.realtime.crossfire.jxclient.commands.ClearCommand

All Implemented Interfaces:

Command

public class ClearCommand
extends AbstractCommand

Implements the command "clear". It clears the active message window.

Constructor Summary

Constructors

Constructor and Description
ClearCommand(@NotNull JXCWindowRenderer windowRenderer, @NotNull CrossfireServerConnection crossfireServerConnection) 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

ClearCommand

public ClearCommand(@NotNull
                    @NotNull JXCWindowRenderer windowRenderer,
                    @NotNull
                    @NotNull CrossfireServerConnection crossfireServerConnection)

Creates a new instance.

Parameters:

windowRenderer - the window renderer to affect

crossfireServerConnection - the connection instance

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