Package org.openhab.core.addon

Class AddonInfo

java.lang.Object
org.openhab.core.addon.AddonInfo
All Implemented Interfaces:
Identifiable<String>
@NonNullByDefault public class AddonInfo extends Object implements Identifiable<String>
The AddonInfo class contains general information about an add-on.

Any add-on information is provided by a AddonInfoProvider and can also be retrieved through the AddonInfoRegistry.

Author:
Michael Grammling - Initial contribution, Andre Fuechsel - Made author tag optional, Jan N. Klug - Refactored to cover all add-ons

  • Method Details

    • getUID

      public String getUID()
      Returns an unique identifier for the add-on (e.g. "binding-hue").
      Specified by:
      getUID in interface Identifiable<String>
      Returns:
      an identifier for the add-on

    • getId

      public String getId()
      Returns the id part of the UID
      Returns:
      the identifier

    • getName

      public String getName()
      Returns a human-readable name for the add-on (e.g. "HUE Binding").
      Returns:
      a human-readable name for the add-on (neither null, nor empty)

    • getType

      public String getType()

    • getServiceId

      public String getServiceId()

    • getDescription

      public String getDescription()
      Returns a human-readable description for the add-on (e.g. "Discovers and controls HUE bulbs").
      Returns:
      a human-readable description for the add-on

    • getConfigDescriptionURI

      public @Nullable String getConfigDescriptionURI()
      Returns the link to a concrete ConfigDescription.
      Returns:
      the link to a concrete ConfigDescription (could be null>)

    • getSourceBundle

      public @Nullable String getSourceBundle()

    • getConnection

      public @Nullable String getConnection()

    • getCountries

      public List<String> getCountries()

    • getDiscoveryMethods

      public List<AddonDiscoveryMethod> getDiscoveryMethods()

    • isMasterAddonInfo

      public boolean isMasterAddonInfo()

    • builder

      public static AddonInfo.Builder builder(String id, String type)

    • builder

      public static AddonInfo.Builder builder(AddonInfo addonInfo)