hudson.plugins.im.bot
Class BuildCommand

java.lang.Object
  hudson.plugins.im.bot.BuildCommand

All Implemented Interfaces:

BotCommand

public class BuildCommand
extends java.lang.Object
implements BotCommand

Build command for the instant messaging bot.

Author:

Pascal Bleser, kutzi

Constructor Summary

BuildCommand(java.lang.String imId)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuildCommand

public BuildCommand(java.lang.String imId)

Parameters:

imId - An identifier describing the Im account used to send the build command. E.g. the Jabber ID of the Bot.

Method Detail

executeCommand

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

Description copied from interface: BotCommand

Execute a command.

Specified by:

executeCommand in interface BotCommand

Parameters:

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

message - the original IMMessage

sender - the room nickname of the command sender // FIXME ckutz: replace with the FQ sender id!

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

Throws:

IMException

getHelp

public java.lang.String getHelp()

Description copied from interface: BotCommand

Return the command usage text.

Specified by:

getHelp in interface BotCommand

Returns:

the command usage text