Package org.openhab.core.addon

Interface AddonInfoProvider

@NonNullByDefault public interface AddonInfoProvider
The AddonInfoProvider is a service interface providing AddonInfo objects. All registered AddonInfoProvider services are tracked by the AddonInfoRegistry and provided as one common collection.
Author:
Michael Grammling - Initial contribution
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable AddonInfo
    getAddonInfo(@Nullable String uid, @Nullable Locale locale)
    Returns the binding information for the specified binding UID and locale (language), or null if no binding information could be found.
    Set<AddonInfo>
    getAddonInfos(@Nullable Locale locale)
    Returns all binding information in the specified locale (language) this provider contains.

  • Method Details

    • getAddonInfo

      @Nullable AddonInfo getAddonInfo(@Nullable String uid, @Nullable Locale locale)
      Returns the binding information for the specified binding UID and locale (language), or null if no binding information could be found.
      Parameters:
      uid - the UID to be looked for (could be null or empty)
      locale - the locale to be used for the binding information (could be null)
      Returns:
      a localized binding information object (could be null)

    • getAddonInfos

      Set<AddonInfo> getAddonInfos(@Nullable Locale locale)
      Returns all binding information in the specified locale (language) this provider contains.
      Parameters:
      locale - the locale to be used for the binding information (could be null)
      Returns:
      a localized set of all binding information this provider contains (could be empty)