Package org.openhab.core.items.fileconverter

Interface ItemSerializer

All Superinterfaces:

ObjectSerializer<Item>

All Known Implementing Classes:

AbstractItemSerializer

@NonNullByDefault
public interface ItemSerializer
extends ObjectSerializer<Item>

ItemSerializer is the interface to implement by any file generator for Item object.

Author:

Laurent Garnier - Initial contribution

Method Summary

Modifier and Type	Method	Description
void	setItemsToBeSerialized(String id, List<Item> items, Collection<Metadata> metadata, Map<String,String> stateFormatters, boolean hideDefaultParameters)	Specify the List of Items (including Metadata and channel links) to be serialized and associate them with an identifier.

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

generateFormat, getGeneratedFormat

Method Details

setItemsToBeSerialized

void setItemsToBeSerialized(String id,
 List<Item> items,
 Collection<Metadata> metadata,
 Map<String,String> stateFormatters,
 boolean hideDefaultParameters)

Specify the List of Items (including Metadata and channel links) to be serialized and associate them with an identifier.

Parameters:

id - the identifier of the Item format generation.

items - the List of Items to serialize.

metadata - the provided Collection of Metadata for the Items (including channel links).

stateFormatters - a Map of Item name and state formatter for each Item. Callers should pass an empty map if no state formatters are provided.

hideDefaultParameters - true to hide the configuration parameters having a default value.