Package org.openhab.core.thing.binding

Class BaseBridgeHandler

java.lang.Object

org.openhab.core.thing.binding.BaseThingHandler

org.openhab.core.thing.binding.BaseBridgeHandler

All Implemented Interfaces:

BridgeHandler, ThingHandler

Direct Known Subclasses:

ConfigStatusBridgeHandler, MagicBridgeHandler

@NonNullByDefault
public abstract class BaseBridgeHandler
extends BaseThingHandler
implements BridgeHandler

The BaseBridgeHandler implements the BridgeHandler interface and adds some convenience methods for bridges to the BaseThingHandler.

It is recommended to extend this abstract base class.

Author:

Dennis Nobel - Initial contribution, Stefan Bußweiler - Added implementation of BridgeHandler interface, Andrew Fiddian-Green - Added semanticEquipmentTag

Field Summary

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

scheduler, thing

Constructor Summary

Constructors

Constructor	Description
BaseBridgeHandler(Bridge bridge)

Method Summary

Modifier and Type	Method	Description
void	childHandlerDisposed(ThingHandler childHandler, Thing childThing)	Informs the bridge handler that a child handler has been disposed.
void	childHandlerInitialized(ThingHandler childHandler, Thing childThing)	Informs the bridge handler that a child handler has been initialized.
protected BridgeBuilder	editThing()	Creates a bridge builder, which allows to modify the bridge.
Bridge	getThing()	Returns the Thing, which belongs to the handler.

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

bridgeStatusChanged, changeThingType, channelLinked, channelUnlinked, dispose, editConfiguration, editProperties, getBridge, getCallback, getConfig, getConfigAs, getConfigDescription, getConfigDescription, 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

bridgeStatusChanged, channelLinked, channelUnlinked, dispose, getServices, handleCommand, handleConfigurationUpdate, handleRemoval, initialize, setCallback, thingUpdated

Constructor Details

BaseBridgeHandler

public BaseBridgeHandler(Bridge bridge)

See Also:

• BaseThingHandler

Method Details

getThing

public Bridge getThing()

Description copied from interface: ThingHandler

Returns the Thing, which belongs to the handler.

Specified by:

getThing in interface ThingHandler

Overrides:

getThing in class BaseThingHandler

Returns:

Thing, which belongs to the handler

editThing

protected BridgeBuilder editThing()

Creates a bridge builder, which allows to modify the bridge. The method BaseThingHandler.updateThing(Thing) must be called to persist the changes.

Overrides:

editThing in class BaseThingHandler

Returns:

BridgeBuilder which builds an exact copy of the bridge

childHandlerInitialized

public void childHandlerInitialized(ThingHandler childHandler,
 Thing childThing)

Description copied from interface: BridgeHandler

Informs the bridge handler that a child handler has been initialized.

Specified by:

childHandlerInitialized in interface BridgeHandler

Parameters:

childHandler - the initialized child handler

childThing - the thing of the initialized child handler

childHandlerDisposed

public void childHandlerDisposed(ThingHandler childHandler,
 Thing childThing)

Description copied from interface: BridgeHandler

Informs the bridge handler that a child handler has been disposed.

Specified by:

childHandlerDisposed in interface BridgeHandler

Parameters:

childHandler - the disposed child handler

childThing - the thing of the disposed child handler