Package org.openhab.core.magic.binding.handler

Class MagicDynamicStateDescriptionThingHandler

java.lang.Object

org.openhab.core.thing.binding.BaseThingHandler

org.openhab.core.magic.binding.handler.MagicDynamicStateDescriptionThingHandler

All Implemented Interfaces:

ThingHandler

@NonNullByDefault
public class MagicDynamicStateDescriptionThingHandler
extends BaseThingHandler

ThingHandler which provides channels with dynamic state descriptions.

Author:

Christoph Weitkamp - Initial contribution

Field Summary

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

scheduler, thing

Constructor Summary

Constructors

Constructor	Description
MagicDynamicStateDescriptionThingHandler(Thing thing, org.openhab.core.magic.binding.internal.MagicDynamicCommandDescriptionProvider commandDescriptionProvider, org.openhab.core.magic.binding.internal.MagicDynamicStateDescriptionProvider stateDescriptionProvider)

Method Summary

Modifier and Type	Method	Description
void	handleCommand(ChannelUID channelUID, Command command)	Handles a command for a given channel.
void	initialize()	Initializes the thing handler, e.g. update thing status, allocate resources, transfer configuration.

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

bridgeStatusChanged, changeThingType, channelLinked, channelUnlinked, dispose, editConfiguration, editProperties, editThing, getBridge, getCallback, getConfig, getConfigAs, getConfigDescription, getConfigDescription, getThing, handleConfigurationUpdate, handleRemoval, isInitialized, isLinked, isLinked, isModifyingCurrentConfig, postCommand, postCommand, sendTimeSeries, sendTimeSeries, setCallback, thingUpdated, triggerChannel, triggerChannel, triggerChannel, triggerChannel, updateConfiguration, updateProperties, updateProperty, updateState, updateState, updateStatus, updateStatus, updateStatus, updateThing, validateConfigurationParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openhab.core.thing.binding.ThingHandler

getServices

Constructor Details

MagicDynamicStateDescriptionThingHandler

public MagicDynamicStateDescriptionThingHandler(Thing thing,
 org.openhab.core.magic.binding.internal.MagicDynamicCommandDescriptionProvider commandDescriptionProvider,
 org.openhab.core.magic.binding.internal.MagicDynamicStateDescriptionProvider stateDescriptionProvider)

Method Details

initialize

public void initialize()

Description copied from interface: ThingHandler

Initializes the thing handler, e.g. update thing status, allocate resources, transfer configuration.

This method is only called, if the Thing contains all required configuration parameters.

Only Things with status ThingStatus.UNKNOWN, ThingStatus.ONLINE or ThingStatus.OFFLINE are considered as initialized by the framework. To achieve that, the status must be reported via ThingHandlerCallback.statusUpdated(Thing, ThingStatusInfo).

The framework expects this method to be non-blocking and return quickly. For longer running initializations, the implementation has to take care of scheduling a separate job which must guarantee to set the thing status eventually.

Any anticipated error situations should be handled gracefully and need to result in ThingStatus.OFFLINE with the corresponding status detail (e.g. *COMMUNICATION_ERROR* or *CONFIGURATION_ERROR* including a meaningful description) instead of throwing exceptions.

handleCommand

public void handleCommand(ChannelUID channelUID,
 Command command)

Description copied from interface: ThingHandler

Handles a command for a given channel.

This method is only called, if the thing has been initialized (status ONLINE/OFFLINE/UNKNOWN).

Parameters:

channelUID - the ChannelUID of the channel to which the command was sent

command - the Command