Package com.inductiveautomation.ignition.gateway.tags.evaluation

Enum Class ShutdownReason

java.lang.Object

java.lang.Enum<ShutdownReason>

com.inductiveautomation.ignition.gateway.tags.evaluation.ShutdownReason

All Implemented Interfaces:

Serializable, Comparable<ShutdownReason>, Constable

public enum ShutdownReason
extends Enum<ShutdownReason>

When objects are uninitialized, it could be due to a normal shutdown, or to something else- like the item being deleted. This can have an impact on the underlying system.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AttemptConfiguration	Actor shutting down triggered by attemptConfiguration
Deleted	Tag was deleted by the user
Invalid	Some issue was found with the tag configuration, and the tag is invalid
Normal	An expected situation such as an invalid tag becoming valid
Restart	Tag was restarted

Method Summary

Modifier and Type	Method	Description
static ShutdownReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ShutdownReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Normal

public static final ShutdownReason Normal

An expected situation such as an invalid tag becoming valid

Invalid

public static final ShutdownReason Invalid

Some issue was found with the tag configuration, and the tag is invalid

Deleted

public static final ShutdownReason Deleted

Tag was deleted by the user

Restart

public static final ShutdownReason Restart

Tag was restarted

AttemptConfiguration

public static final ShutdownReason AttemptConfiguration

Actor shutting down triggered by attemptConfiguration

Method Details

values

public static ShutdownReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ShutdownReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null