org.apache.ambari.server.state

Enum NotificationState

java.lang.Object

java.lang.Enum<NotificationState>

org.apache.ambari.server.state.NotificationState

All Implemented Interfaces:

Serializable, Comparable<NotificationState>

public enum NotificationState
extends Enum<NotificationState>

The NotificationState class represents the various states that an outbound notification can exist in. It allows tracking and history for notifications that are pending, have succeeded, or were processed but failed to be sent successfully.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELIVERED The notification was processed successfully.
DISPATCHED The notification was picked up and processed by the dispatcher, but there is no information on whether the delivery was successful.
FAILED The notification was processed, but failed to be sent.
PENDING The notification has not yet been processed by the notification system.

Method Summary

Modifier and Type	Method and Description
static NotificationState	valueOf(String name) Returns the enum constant of this type with the specified name.
static NotificationState[]	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

PENDING

public static final NotificationState PENDING

The notification has not yet been processed by the notification system.

FAILED

public static final NotificationState FAILED

The notification was processed, but failed to be sent. It will not be processed again.

DELIVERED

public static final NotificationState DELIVERED

The notification was processed successfully.

DISPATCHED

public static final NotificationState DISPATCHED

The notification was picked up and processed by the dispatcher, but there is no information on whether the delivery was successful.

Method Detail

values

public static NotificationState[] 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 (NotificationState c : NotificationState.values())
    System.out.println(c);

Returns:

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

valueOf

public static NotificationState 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