Package org.openhab.core.sitemap.registry

Interface SitemapFactory

@NonNullByDefault public interface SitemapFactory
The SitemapFactory is used to create Sitemaps and Widgets from their type string.
Author:
Mark Herwege - Initial contribution

  • Method Details

    • createSitemap

      Sitemap createSitemap(String sitemapName)
      Creates a new Sitemap instance with name sitemapName
      Parameters:
      sitemapName -
      Returns:
      a new Sitemap.

    • createWidget

      @Nullable Widget createWidget(String widgetTypeName)
      Creates a new Widget instance of type widgetTypeName
      Parameters:
      widgetTypeName -
      Returns:
      a new Widget of type widgetTypeName or null if no matching class is known.

    • createWidget

      @Nullable Widget createWidget(String widgetTypeName, Parent parent)
      Creates a new Widget instance of type widgetTypeName and with Parent parent
      Parameters:
      widgetTypeName -
      parent -
      Returns:
      a new Widget of type widgetTypeName or null if no matching class is known.

    • createButtonDefinition

      ButtonDefinition createButtonDefinition()
      Creates a ButtonDefinition instance
      Returns:
      a new ButtonDefinition.

    • createMapping

      Mapping createMapping()
      Creates a Mapping instance
      Returns:
      a new Mapping.

    • createRule

      Rule createRule()
      Creates a Rule instance
      Returns:
      a new Rule.

    • createCondition

      Condition createCondition()
      Creates a Rule Condition instance
      Returns:
      a new Rule Condition.

    • getSupportedWidgetTypes

      String[] getSupportedWidgetTypes()
      Returns the list of all supported WidgetTypes of this Factory.
      Returns:
      the supported WidgetTypes