Package org.openhab.core.thing.fileconverter

Interface ThingFileGenerator

All Known Implementing Classes:
AbstractThingFileGenerator
@NonNullByDefault public interface ThingFileGenerator
ThingFileGenerator is the interface to implement by any file generator for Thing object.
Author:
Laurent Garnier - Initial contribution

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generateFileFormat(String id, OutputStream out)
    Generate the file format for all data that were associated to the provided identifier.
    String
    getFileFormatGenerator()
    Returns the format of the file.
    void
    setThingsToBeGenerated(String id, List<Thing> things, boolean hideDefaultChannels, boolean hideDefaultParameters)
    Define the list of things to be generated and associate them to an identifier.

  • Method Details

    • getFileFormatGenerator

      String getFileFormatGenerator()
      Returns the format of the file.
      Returns:
      the file format

    • setThingsToBeGenerated

      void setThingsToBeGenerated(String id, List<Thing> things, boolean hideDefaultChannels, boolean hideDefaultParameters)
      Define the list of things to be generated and associate them to an identifier.
      Parameters:
      id - the identifier of the file format generation
      things - the things
      hideDefaultChannels - true to hide the non extensible channels having a default configuration
      hideDefaultParameters - true to hide the configuration parameters having the default value

    • generateFileFormat

      void generateFileFormat(String id, OutputStream out)
      Generate the file format for all data that were associated to the provided identifier.
      Parameters:
      id - the identifier of the file format generation
      out - the output stream to write to