Package org.openhab.core.config.core.xml.osgi

Interface XmlDocumentProvider<T>

Type Parameters:
T - the result type of the conversion
@NonNullByDefault public interface XmlDocumentProvider<@NonNull T>
The XmlDocumentProvider is responsible managing any created objects by a ConfigDescriptionReader for a certain module.

Each instance of this class is assigned to exactly one module.

Author:
Michael Grammling - Initial contribution

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addingFinished()
    Signals that all available result objects from the XML processing of the certain module have been added.
    void
    addingObject(@NonNull T object)
    Adds a new result object from the XML processing for further processing.
    void
    release()
    Releases any added result objects from the XML processing.

  • Method Details

    • addingObject

      void addingObject(@NonNull T object)
      Adds a new result object from the XML processing for further processing.
      Parameters:
      object - the result object to be processed

    • addingFinished

      void addingFinished()
      Signals that all available result objects from the XML processing of the certain module have been added.

    • release

      void release()
      Releases any added result objects from the XML processing.