Package org.openhab.core.automation.converter

Enum Class RuleSerializer.RuleSerializationOption

java.lang.Object

java.lang.Enum<RuleSerializer.RuleSerializationOption>

org.openhab.core.automation.converter.RuleSerializer.RuleSerializationOption

All Implemented Interfaces:

Serializable, Comparable<RuleSerializer.RuleSerializationOption>, Constable

Enclosing interface:

RuleSerializer

public static enum RuleSerializer.RuleSerializationOption
extends Enum<RuleSerializer.RuleSerializationOption>

An enum representing the different rule serialization options.

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
INCLUDE_ALL	Everything is serialized, including empty collections
NORMAL	Empty collections and normally irrelevant fields are hidden
STRIP_TEMPLATE	Template information is stripped, otherwise like NORMAL
STUB_ONLY	Only the fields required in a rule stub to be used with a template is serialized

Method Summary

Modifier and Type	Method	Description
static @Nullable RuleSerializer.RuleSerializationOption	fromString(@Nullable String id)
String	toString()
static RuleSerializer.RuleSerializationOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RuleSerializer.RuleSerializationOption[]	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

NORMAL

public static final RuleSerializer.RuleSerializationOption NORMAL

Empty collections and normally irrelevant fields are hidden

INCLUDE_ALL

public static final RuleSerializer.RuleSerializationOption INCLUDE_ALL

Everything is serialized, including empty collections

STUB_ONLY

public static final RuleSerializer.RuleSerializationOption STUB_ONLY

Only the fields required in a rule stub to be used with a template is serialized

STRIP_TEMPLATE

public static final RuleSerializer.RuleSerializationOption STRIP_TEMPLATE

Template information is stripped, otherwise like NORMAL

Method Details

values

public static RuleSerializer.RuleSerializationOption[] 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 RuleSerializer.RuleSerializationOption 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<RuleSerializer.RuleSerializationOption>

fromString

public static @Nullable RuleSerializer.RuleSerializationOption fromString(@Nullable String id)