Package com.inductiveautomation.ignition.common.alarming

Enum AlarmState

    • 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)  
      static java.util.List<AlarmState> standardStates()  
      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.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • 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

      • Disabled

        public static final AlarmState Disabled

    • 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 name
        java.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 class java.lang.Enum<AlarmState>

      • toString

        public java.lang.String toString​(java.util.Locale locale)
        Specified by:
        toString in interface Localized

      • standardStates

        public static java.util.List<AlarmState> standardStates()