hudson.plugins.im.bot
Class SetAliasCommand.AliasCommand

java.lang.Object
  hudson.plugins.im.bot.SetAliasCommand.AliasCommand

All Implemented Interfaces:

BotCommand

Enclosing class:

SetAliasCommand

public static class SetAliasCommand.AliasCommand
extends java.lang.Object
implements BotCommand

An alias.

Constructor Summary

SetAliasCommand.AliasCommand(BotCommand cmd, java.lang.String commandName, java.lang.String[] arguments)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SetAliasCommand.AliasCommand

public SetAliasCommand.AliasCommand(BotCommand cmd,
                                    java.lang.String commandName,
                                    java.lang.String[] arguments)

Method Detail

executeCommand

public void executeCommand(IMChat chat,
                           IMMessage message,
                           Sender 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 command sender

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