Package org.openhab.core.automation

Enum Class Rule.TemplateState

java.lang.Object

java.lang.Enum<Rule.TemplateState>

org.openhab.core.automation.Rule.TemplateState

All Implemented Interfaces:

Serializable, Comparable<Rule.TemplateState>, Constable

Enclosing interface:

Rule

public static enum Rule.TemplateState
extends Enum<Rule.TemplateState>

This enum represent the different states a rule can have in respect to rule templates.

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
INSTANTIATED	This Rule is associated with a template and has been instantiated
NO_TEMPLATE	This Rule isn't associated with a template
PENDING	This Rule is associated with a template and it has yet to be instantiated
TEMPLATE_MISSING	This Rule is associated with a template that wasn't found

Method Summary

Modifier and Type	Method	Description
String	toString()
static Rule.TemplateState	typeOf(@Nullable String templateState)	Returns the Rule.TemplateState that best represents the specified string.
static Rule.TemplateState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Rule.TemplateState[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_TEMPLATE

public static final Rule.TemplateState NO_TEMPLATE

This Rule isn't associated with a template

PENDING

public static final Rule.TemplateState PENDING

This Rule is associated with a template and it has yet to be instantiated

TEMPLATE_MISSING

public static final Rule.TemplateState TEMPLATE_MISSING

This Rule is associated with a template that wasn't found

INSTANTIATED

public static final Rule.TemplateState INSTANTIATED

This Rule is associated with a template and has been instantiated

Method Details

values

public static Rule.TemplateState[] 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 Rule.TemplateState 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

toString

public String toString()

Overrides:

toString in class Enum<Rule.TemplateState>

typeOf

public static Rule.TemplateState typeOf(@Nullable String templateState)

Returns the Rule.TemplateState that best represents the specified string. If no match is found, NO_TEMPLATE is returned.

Parameters:

templateState - the string to convert.

Returns:

The resulting Rule.TemplateState.