Package org.openhab.core.automation.converter

Interface RuleSerializer

All Superinterfaces:

ObjectSerializer<Rule>

@NonNullByDefault
public interface RuleSerializer
extends ObjectSerializer<Rule>

RuleSerializer is the interface to implement by any file generator for Rule object.

Author:

Ravi Nadahar - Initial contribution

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RuleSerializer.RuleSerializationOption	An enum representing the different rule serialization options.

Method Summary

Modifier and Type	Method	Description
List<SerializabilityResult<String>>	checkSerializability(Collection<Rule> rules)	Checks if the specified rules are serializable with this RuleSerializer.
void	setRulesToBeSerialized(String id, List<Rule> rules, RuleSerializer.RuleSerializationOption option)	Specify the List of Rules to be serialized and associate them with an identifier.

Methods inherited from interface org.openhab.core.converter.ObjectSerializer

generateFormat, getGeneratedFormat

Method Details

checkSerializability

List<SerializabilityResult<String>> checkSerializability(Collection<Rule> rules)

Checks if the specified rules are serializable with this RuleSerializer. Returned results are in the same order as the specified rules.

Parameters:

rules - the List of Rules to check.

Returns:

The resulting List of SerializabilityResults.

setRulesToBeSerialized

void setRulesToBeSerialized(String id,
 List<Rule> rules,
 RuleSerializer.RuleSerializationOption option)
                     throws SerializationException

Specify the List of Rules to be serialized and associate them with an identifier.

Parameters:

id - the identifier of the Rule format generation.

rules - the List of Rules to serialize.

option - the option that determines how to serialize the Rules.

Throws:

SerializationException - If one or more of the rules can't be serialized.