hudson.plugins.im.bot
Interface BotCommand

All Known Implementing Classes:

AbortCommand, AbstractTextSendingCommand, BuildCommand, CommentCommand, HealthCommand, QueueCommand, SetAliasCommand, SetAliasCommand.AliasCommand, SnackCommand, StatusCommand, TestResultCommand, UserStatCommand

public interface BotCommand

Command pattern contract for Jabber bot commands.

Author:

Pascal Bleser, Christoph Kutzinski

See Also:

Bot

Method Summary

void	executeCommand(IMChat chat, IMMessage message, Sender sender, java.lang.String[] args) Execute a command.
java.lang.String	getHelp() Return the command usage text.

Method Detail

executeCommand

void executeCommand(IMChat chat,
                    IMMessage message,
                    Sender sender,
                    java.lang.String[] args)
                    throws IMException

Execute a command.

Parameters:

chat - the IMChat object, may be used to send reply messages

message - the original IMMessage

sender - the command sender

args - arguments passed to the command, where args[0] is the command name itself

Throws:

IMException

getHelp

java.lang.String getHelp()

Return the command usage text.

Returns:

the command usage text