Package org.openhab.core.automation

Enum Class RuleStatusDetail

java.lang.Object

java.lang.Enum<RuleStatusDetail>

org.openhab.core.automation.RuleStatusDetail

All Implemented Interfaces:

Serializable, Comparable<RuleStatusDetail>, Constable

@NonNullByDefault
public enum RuleStatusDetail
extends Enum<RuleStatusDetail>

This enumeration is used to represent a detail of a RuleStatus. It can be considered as a sub-status. It shows the specific reasons why the status of the rule is like as is.

Rule Status Details

Detail/Status	UNINITIALIZED	INITIALIZING	IDLE	RUNNING
NONE	Initial State	Resolving started	Successfully resolved	Running
CONFIGURATION_ERROR	Resolving failed	N/A	N/A	N/A
HANDLER_INITIALIZING_ERROR	Resolving failed	N/A	N/A	N/A
HANDLER_MISSING_ERROR	Resolving failed	N/A	N/A	N/A
TEMPLATE_MISSING_ERROR	Resolving failed	N/A	N/A	N/A
INVALID_RULE	Resolving failed	N/A	N/A	N/A
DISABLED	Disabled	N/A	N/A	N/A

Author:

Yordan Mihaylov - Initial contribution, Kai Kreuzer - Refactored to match ThingStatusDetail 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
CONFIGURATION_ERROR
DISABLED
HANDLER_INITIALIZING_ERROR
HANDLER_MISSING_ERROR
INVALID_RULE
NONE
TEMPLATE_MISSING_ERROR

Method Summary

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

NONE

public static final RuleStatusDetail NONE

HANDLER_MISSING_ERROR

public static final RuleStatusDetail HANDLER_MISSING_ERROR

HANDLER_INITIALIZING_ERROR

public static final RuleStatusDetail HANDLER_INITIALIZING_ERROR

CONFIGURATION_ERROR

public static final RuleStatusDetail CONFIGURATION_ERROR

TEMPLATE_MISSING_ERROR

public static final RuleStatusDetail TEMPLATE_MISSING_ERROR

INVALID_RULE

public static final RuleStatusDetail INVALID_RULE

DISABLED

public static final RuleStatusDetail DISABLED

Method Details

values

public static RuleStatusDetail[] 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 RuleStatusDetail 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 the status detail.

Returns:

the value of the status detail.