hudson.plugins.jabber.im.transport.bot
Interface BotCommand

All Known Implementing Classes:

AbortCommand, AbstractTextSendingCommand, AliasCommand, BuildCommand, HealthCommand, JobOverviewCommand, QueueCommand, SnackCommand, StatusCommand, TestResultCommand

public interface BotCommand

Command pattern contract for Jabber bot commands.

Author:

Pascal Bleser

See Also:

Bot

Method Summary

void	executeCommand(JabberChat chat, org.jivesoftware.smack.packet.Message message, java.lang.String sender, java.lang.String[] args) Execute a command.
java.lang.String	getHelp() Return the command usage text.

Method Detail

executeCommand

void executeCommand(JabberChat chat,
                    org.jivesoftware.smack.packet.Message message,
                    java.lang.String sender,
                    java.lang.String[] args)
                    throws org.jivesoftware.smack.XMPPException

Execute a command.

Parameters:

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

message - the original Message

sender - the room nickname of the command sender

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

Throws:

org.jivesoftware.smack.XMPPException

getHelp

java.lang.String getHelp()

Return the command usage text.

Returns:

the command usage text