Package org.openhab.core.service

Interface StateDescriptionService

@NonNullByDefault public interface StateDescriptionService
Implementations of this service provide strategies for merging info from different StateDescriptionProviders into one StateDescription.
Author:
Lyubomir Papazov - Initial contribution

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable StateDescription
    getStateDescription(String itemName, @Nullable Locale locale)
    Implementations of this method merge the StateDescriptions provided from multiple StateDescriptionProviders into one final StateDescription.

  • Method Details

    • getStateDescription

      @Nullable StateDescription getStateDescription(String itemName, @Nullable Locale locale)
      Implementations of this method merge the StateDescriptions provided from multiple StateDescriptionProviders into one final StateDescription.
      Parameters:
      itemName - the item for which to get the StateDescription (must not be null)
      locale - locale (can be null)
      Returns:
      state description or null if no state description could be found