Package org.openhab.core.thing.binding

Class BaseDynamicCommandDescriptionProvider

java.lang.Object

org.openhab.core.thing.binding.AbstractDynamicDescriptionProvider

org.openhab.core.thing.binding.BaseDynamicCommandDescriptionProvider

All Implemented Interfaces:

DynamicCommandDescriptionProvider

@NonNullByDefault
public abstract class BaseDynamicCommandDescriptionProvider
extends AbstractDynamicDescriptionProvider
implements DynamicCommandDescriptionProvider

The BaseDynamicCommandDescriptionProvider provides a base implementation for the DynamicCommandDescriptionProvider.

It provides localized dynamic CommandOptions. Therefore the inheriting class has to request a reference for the ChannelTypeI18nLocalizationService on its own.

Author:

Christoph Weitkamp - Initial contribution, Christoph Weitkamp - Added ChannelStateDescriptionChangedEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<ChannelUID,List<CommandOption>>	channelOptionsMap

Fields inherited from class org.openhab.core.thing.binding.AbstractDynamicDescriptionProvider

bundleContext, channelTypeI18nLocalizationService, eventPublisher, itemChannelLinkRegistry

Constructor Summary

Constructors

Constructor	Description
BaseDynamicCommandDescriptionProvider()

Method Summary

Modifier and Type	Method	Description
void	deactivate()
@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.
protected List<CommandOption>	localizedCommandOptions(List<CommandOption> options, Channel channel, @Nullable Locale locale)	Localizes a List of CommandOptions that should be used for the channel.
void	setCommandOptions(ChannelUID channelUID, List<CommandOption> options)	For a given ChannelUID, set a List of CommandOptions that should be used for the channel, instead of the one defined statically in the ChannelType.

Methods inherited from class org.openhab.core.thing.binding.AbstractDynamicDescriptionProvider

activate, postEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

channelOptionsMap

protected final Map<ChannelUID,List<CommandOption>> channelOptionsMap

Constructor Details

BaseDynamicCommandDescriptionProvider

public BaseDynamicCommandDescriptionProvider()

Method Details

setCommandOptions

public void setCommandOptions(ChannelUID channelUID,
 List<CommandOption> options)

For a given ChannelUID, set a List of CommandOptions that should be used for the channel, instead of the one defined statically in the ChannelType.

Parameters:

channelUID - the ChannelUID of the channel

options - a List of CommandOptions

getCommandDescription

public @Nullable CommandDescription getCommandDescription(Channel channel,
 @Nullable CommandDescription originalCommandDescription,
 @Nullable Locale locale)

Description copied from interface: DynamicCommandDescriptionProvider

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.

Specified by:

getCommandDescription in interface DynamicCommandDescriptionProvider

Parameters:

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)

Returns:

command description or null if none provided

localizedCommandOptions

protected List<CommandOption> localizedCommandOptions(List<CommandOption> options,
 Channel channel,
 @Nullable Locale locale)

Localizes a List of CommandOptions that should be used for the channel.

Parameters:

options - a List of CommandOptions

channel - the channel

locale - a locale

Returns:

the localized List of CommandOptions

deactivate

public void deactivate()

Overrides:

deactivate in class AbstractDynamicDescriptionProvider