Package org.openhab.core.automation.converter

Interface RuleTemplateSerializer

All Superinterfaces:

ObjectSerializer<RuleTemplate>

@NonNullByDefault
public interface RuleTemplateSerializer
extends ObjectSerializer<RuleTemplate>

RuleTemplateSerializer is the interface to implement by any file generator for RuleTemplate object.

Author:

Ravi Nadahar - Initial contribution

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RuleTemplateSerializer.RuleTemplateSerializationOption	An enum representing the different rule template serialization options.

Method Summary

Modifier and Type	Method	Description
List<SerializabilityResult<String>>	checkSerializability(Collection<RuleTemplate> templates)	Checks if the specified rule templates are serializable with this RuleTemplateSerializer.
void	setTemplatesToBeSerialized(String id, List<RuleTemplate> templates, RuleTemplateSerializer.RuleTemplateSerializationOption option)	Specify the List of RuleTemplates 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<RuleTemplate> templates)

Checks if the specified rule templates are serializable with this RuleTemplateSerializer. Returned results are in the same order as the specified rule templates.

Parameters:

templates - the List of RuleTemplates to check.

Returns:

The resulting List of SerializabilityResults.

setTemplatesToBeSerialized

void setTemplatesToBeSerialized(String id,
 List<RuleTemplate> templates,
 RuleTemplateSerializer.RuleTemplateSerializationOption option)
                         throws SerializationException

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

Parameters:

id - the identifier of the RuleTemplate format generation.

templates - the List of RuleTemplates to serialize.

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

Throws:

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