org.lsst.ccs.localdb.statusdb

Enum LocalDBAlert

java.lang.Object

java.lang.Enum<LocalDBAlert>

org.lsst.ccs.localdb.statusdb.LocalDBAlert

All Implemented Interfaces:

Serializable, Comparable<LocalDBAlert>

public enum LocalDBAlert
extends Enum<LocalDBAlert>

Alerts raised by localdb.

Author:

emarin

Enum Constant Summary

Enum Constants

Enum Constant and Description
BatchException
BatchMaxCapacity
BatchRollbackException
ConfigurationPersistenceException
WrongStatePersistence

Method Summary

Modifier and Type	Method and Description
LocalDBAlert	addData(String key, Object o) Adds data to the Alert.
org.lsst.ccs.bus.data.Alert	getAlert(String prefix, Exception ex) Generates the actual Alert object.
static String	getFirstException(Exception ex) An utility that returns the original cause of an exception.
String	getId()
static LocalDBAlert	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocalDBAlert[]	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

BatchException

public static final LocalDBAlert BatchException

BatchRollbackException

public static final LocalDBAlert BatchRollbackException

BatchMaxCapacity

public static final LocalDBAlert BatchMaxCapacity

ConfigurationPersistenceException

public static final LocalDBAlert ConfigurationPersistenceException

WrongStatePersistence

public static final LocalDBAlert WrongStatePersistence

Method Detail

values

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

Returns:

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

valueOf

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

getId

public String getId()

addData

public LocalDBAlert addData(String key,
                            Object o)

Adds data to the Alert.

Parameters:

key -

o -

Returns:

getAlert

public org.lsst.ccs.bus.data.Alert getAlert(String prefix,
                                            Exception ex)

Generates the actual Alert object.

Parameters:

prefix - a prefix to add to the alertId.

ex - an exception

Returns:

getFirstException

public static String getFirstException(Exception ex)

An utility that returns the original cause of an exception.

Parameters:

ex -

Returns:

the string representation of the original exception.