Enum AlarmState
- java.lang.Object
-
- java.lang.Enum<AlarmState>
-
- com.inductiveautomation.ignition.common.alarming.AlarmState
-
- All Implemented Interfaces:
Localized
,java.io.Serializable
,java.lang.Comparable<AlarmState>
public enum AlarmState extends java.lang.Enum<AlarmState> implements Localized
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ActiveAcked
ActiveUnacked
ClearAcked
ClearUnacked
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AlarmState
acknowledge()
A convenience function to get the next state when the current one is acknowledged.static AlarmState
get(boolean clear, boolean ack)
boolean
isAcked()
A convenience function for telling whether this is one of the acknowledged states or not.boolean
isActive()
Convenience function for telling whether this is one of the active states.boolean
isEquivilent(java.lang.Object o)
java.lang.String
toString()
java.lang.String
toString(java.util.Locale locale)
static AlarmState
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static AlarmState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ClearUnacked
public static final AlarmState ClearUnacked
-
ClearAcked
public static final AlarmState ClearAcked
-
ActiveUnacked
public static final AlarmState ActiveUnacked
-
ActiveAcked
public static final AlarmState ActiveAcked
-
-
Method Detail
-
values
public static AlarmState[] 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 (AlarmState c : AlarmState.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AlarmState valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
isAcked
public boolean isAcked()
A convenience function for telling whether this is one of the acknowledged states or not.
-
isActive
public boolean isActive()
Convenience function for telling whether this is one of the active states.
-
acknowledge
public AlarmState acknowledge()
A convenience function to get the next state when the current one is acknowledged.
-
isEquivilent
public boolean isEquivilent(java.lang.Object o)
-
get
public static AlarmState get(boolean clear, boolean ack)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<AlarmState>
-
-