org.apache.polygene.library.alarm

Enum AlarmClass

java.lang.Object

java.lang.Enum<AlarmClass>

org.apache.polygene.library.alarm.AlarmClass

All Implemented Interfaces:

Serializable, Comparable<AlarmClass>

public enum AlarmClass
extends Enum<AlarmClass>

AlarmClass is required attribute for Alarms, to indicate the urgency of the AlarmPoint.

Enum Constant Summary

Enum Constants

Enum Constant and Description
A A-alarms requires immediate attention, no matter time of day or day of year.
B B-alarms require attention during working hours.
C C-alarm indicate things that needs to be attended to during regular maintenance cycles or when spare time is available.
D D-alarms are used for notifications that indicates smaller issues, or things that can not be dealt with by humans and will self-correct over time.

Method Summary

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

A

public static final AlarmClass A

A-alarms requires immediate attention, no matter time of day or day of year. In the enterprise world, they indicate issue with mission-critical, 24/7, functions.

B

public static final AlarmClass B

B-alarms require attention during working hours.

C

public static final AlarmClass C

C-alarm indicate things that needs to be attended to during regular maintenance cycles or when spare time is available.

D

public static final AlarmClass D

D-alarms are used for notifications that indicates smaller issues, or things that can not be dealt with by humans and will self-correct over time. They are also used to produce events for general notifications that are informative in nature, such as reports.

Method Detail

values

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

Returns:

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

valueOf

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