Package org.openhab.core.automation

Enum Class RuleStatus

java.lang.Object

java.lang.Enum<RuleStatus>

org.openhab.core.automation.RuleStatus

All Implemented Interfaces:

Serializable, Comparable<RuleStatus>, Constable

@NonNullByDefault
public enum RuleStatus
extends Enum<RuleStatus>

This enumeration is used to present the main status of a Rule.

Rule Status transitions

From/To	UNINITIALIZED	INITIALIZING	IDLE	RUNNING
UNINITIALIZED	N/A	Add: Rule, ModuleHandler, ModuleType, Template Update: Rule	N/A	N/A
INITIALIZING	Resolving fails, Disable rule	N/A	Resolving succeeds	N/A
IDLE	Remove: Rule, ModuleHandler Update: ModuleType Disable: Rule	N/A	N/A	Triggered runNow
RUNNING	Remove: Rule, ModuleHandler Update: ModuleType Disable: Rule	N/A	Execution finished	N/A

Author:

Yordan Mihaylov - Initial contribution, Kai Kreuzer - Refactored to match ThingStatus implementation, Ana Dimova - add java doc

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
IDLE
INITIALIZING
RUNNING
UNINITIALIZED

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the value of a rule status.
static RuleStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RuleStatus[]	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

UNINITIALIZED

public static final RuleStatus UNINITIALIZED

INITIALIZING

public static final RuleStatus INITIALIZING

IDLE

public static final RuleStatus IDLE

RUNNING

public static final RuleStatus RUNNING

Method Details

values

public static RuleStatus[] 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 RuleStatus 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

getValue

public int getValue()

Gets the value of a rule status.

Returns:

the value