Interface DynamicCommandDescriptionProvider

All Known Implementing Classes:

@NonNullByDefault public interface DynamicCommandDescriptionProvider
Implementations may provide Channel specific CommandDescriptions. Therefore the provider must be registered as OSGi service.
Henning Treu - Initial contribution
  • Method Details

    • getCommandDescription

      @Nullable CommandDescription getCommandDescription(Channel channel, @Nullable CommandDescription originalCommandDescription, @Nullable Locale locale)
      For a given Channel, return a CommandDescription that should be used for the channel, instead of the one defined statically in the ChannelType. For a particular channel, there should be only one provider of the dynamic command description. When more than one description is provided for the same channel (by different providers), only one will be used, from the provider that registered first. If the given channel will not be managed by the provider null should be returned. You never must return the original command description in such case.
      channel - channel
      originalCommandDescription - original command description retrieved from the channel type this is the description to be replaced by the provided one
      locale - locale (can be null)
      command description or null if none provided