Package org.openhab.core.items.fileconverter

Interface ItemFileGenerator

All Known Implementing Classes:

AbstractItemFileGenerator

@NonNullByDefault
public interface ItemFileGenerator

ItemFileGenerator 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	generateFileFormat(OutputStream out, List<Item> items, Collection<Metadata> metadata, boolean hideDefaultParameters)	Generate the file format for a sorted list of items.
String	getFileFormatGenerator()	Returns the format of the file.

Method Details

getFileFormatGenerator

String getFileFormatGenerator()

Returns the format of the file.

Returns:

the file format

generateFileFormat

void generateFileFormat(OutputStream out,
 List<Item> items,
 Collection<Metadata> metadata,
 boolean hideDefaultParameters)

Generate the file format for a sorted list of items.

Parameters:

out - the output stream to write the generated syntax to

items - the items

metadata - the provided collection of metadata for these items (including channel links)

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