com.realtime.crossfire.jxclient.commands

Interface Command

All Known Implementing Classes:

AbstractCommand, AgainCommand, BindCommand, BindingsCommand, ClearCommand, DebugMessagesCommand, ExecCommand, HelpCommand, ScreenshotCommand, ScriptCommand, ScriptkillallCommand, ScriptkillCommand, ScriptsCommand, ScripttellCommand, SetCommand, ShortcutCommand, UnbindCommand

public interface Command

Implements a client-side command.

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	getCommandName() Returns the name of the command.
@NotNull java.lang.String	getHelp() Returns the help text for this command.

Method Detail

getCommandName

@NotNull
@NotNull java.lang.String getCommandName()

Returns the name of the command.

Returns:

the name

allArguments

boolean allArguments()

Returns whether all remaining commands should be included as arguments.

Returns:

whether all remaining commands should be included as arguments

execute

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

Executes the command with the given arguments.

Parameters:

args - the command arguments

getHelp

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

Returns the help text for this command.

Returns:

the help text