Package org.openhab.core.config.core

Interface ConfigDescriptionProvider

All Known Implementing Classes:
AbstractXmlConfigDescriptionProvider, ConfigXmlConfigDescriptionProvider, ScriptTransformationService
@NonNullByDefault public interface ConfigDescriptionProvider
The ConfigDescriptionProvider can be implemented and registered as an OSGi service to provide ConfigDescriptions.
Author:
Dennis Nobel - Initial contribution, Michael Grammling - Initial contribution

  • Method Details

    • getConfigDescriptions

      Collection<ConfigDescription> getConfigDescriptions(@Nullable Locale locale)
      Provides a collection of ConfigDescriptions.
      Parameters:
      locale - locale
      Returns:
      the configuration descriptions provided by this provider (not null, could be empty)

    • getConfigDescription

      @Nullable ConfigDescription getConfigDescription(URI uri, @Nullable Locale locale)
      Provides a ConfigDescription for the given URI.
      Parameters:
      uri - uri of the config description
      locale - locale
      Returns:
      config description or null if no config description could be found