hudson.plugins.im.bot
Class HealthCommand

java.lang.Object
  hudson.plugins.im.bot.AbstractTextSendingCommand
      hudson.plugins.im.bot.HealthCommand

All Implemented Interfaces:

BotCommand

public class HealthCommand
extends AbstractTextSendingCommand

Displays the health for one or several jobs.

Author:

kutzi

Constructor Summary

HealthCommand()

Method Summary

protected java.lang.String	getCommandShortName() Returns a short name of the command needed for the help message and as a leading descriptor in the result message.
java.lang.String	getHelp() Return the command usage text.
protected java.lang.CharSequence	getMessageForJob(hudson.model.AbstractProject<?,?> project) Returns the message to return for this job.
protected java.lang.String	getReply(Sender sender, java.lang.String[] args) Gets the text reply

Methods inherited from class hudson.plugins.im.bot.AbstractTextSendingCommand

executeCommand, getErrorReply, getJobProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCommand

public HealthCommand()

Method Detail

getMessageForJob

protected java.lang.CharSequence getMessageForJob(hudson.model.AbstractProject<?,?> project)

Returns the message to return for this job. Note that AbstractMultipleJobCommand already inserts one newline after each job's message so you don't have to do it yourself.

Parameters:

project - The job

Returns:

the result message for this job

getCommandShortName

protected java.lang.String getCommandShortName()

Returns a short name of the command needed for the help message and as a leading descriptor in the result message.

Returns:

short command name

getReply

protected java.lang.String getReply(Sender sender,
                                    java.lang.String[] args)

Description copied from class: AbstractTextSendingCommand

Gets the text reply

Specified by:

getReply in class AbstractTextSendingCommand

Parameters:

sender - the command sender

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

getHelp

public java.lang.String getHelp()

Description copied from interface: BotCommand

Return the command usage text.

Returns:

the command usage text