hudson.plugins.sametime

Enum NotificationStrategy

java.lang.Object

java.lang.Enum<NotificationStrategy>

hudson.plugins.sametime.NotificationStrategy

All Implemented Interfaces:

Serializable, Comparable<NotificationStrategy>

public enum NotificationStrategy
extends Enum<NotificationStrategy>

Represents the notification strategy.

Author:

Uwe Schaefer

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Not matter what, notifications sould always be sent.
ANY_FAILURE Whenever there is a failure, a Notification should be sent.
STATECHANGE_ONLY Notifications should be sent only if there was a change in the build state, or this was the first build.

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	notificationWanted(hudson.model.AbstractBuild<?,?> build) Signals if the given build qualifies to send a notification according to the current strategy.
static NotificationStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static NotificationStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STATECHANGE_ONLY

public static final NotificationStrategy STATECHANGE_ONLY

Notifications should be sent only if there was a change in the build state, or this was the first build.

ALL

public static final NotificationStrategy ALL

Not matter what, notifications sould always be sent.

ANY_FAILURE

public static final NotificationStrategy ANY_FAILURE

Whenever there is a failure, a Notification should be sent.

Method Detail

values

public static NotificationStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NotificationStrategy c : NotificationStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NotificationStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

notificationWanted

public abstract boolean notificationWanted(hudson.model.AbstractBuild<?,?> build)

Signals if the given build qualifies to send a notification according to the current strategy.

Parameters:

build - The build for which it should be decided, if notification is wanted or not.

Returns:

true if, according to the given strategy, a notification should be sent.