Package org.openhab.core.automation.handler

Class BaseModuleHandler<T extends Module>

java.lang.Object

org.openhab.core.automation.handler.BaseModuleHandler<T>

All Implemented Interfaces:

ModuleHandler

Direct Known Subclasses:

BaseActionModuleHandler, BaseConditionModuleHandler, BaseTriggerModuleHandler

@NonNullByDefault
public class BaseModuleHandler<T extends Module>
extends Object
implements ModuleHandler

This is a base class that can be used by any ModuleHandler implementation

Author:

Kai Kreuzer - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable ModuleHandlerCallback	callback
protected T	module

Constructor Summary

Constructors

Constructor	Description
BaseModuleHandler(T module)

Method Summary

Modifier and Type	Method	Description
void	dispose()	The method is called by RuleManager to free resources when ModuleHandler is released.
protected Configuration	getConfig()	Returns the configuration of the module.
protected <C> C	getConfigAs(Class<C> configurationClass)	Returns the configuration of the module and transforms it to the given class.
void	setCallback(ModuleHandlerCallback callback)	The callback is injected to the handler through this method.

Methods inherited from class java.lang.Object

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

Field Details

module

protected T extends Module module

callback

protected @Nullable ModuleHandlerCallback callback

Constructor Details

BaseModuleHandler

public BaseModuleHandler(T module)

Method Details

setCallback

public void setCallback(ModuleHandlerCallback callback)

Description copied from interface: ModuleHandler

The callback is injected to the handler through this method.

Specified by:

setCallback in interface ModuleHandler

Parameters:

callback - a ModuleHandlerCallback instance

dispose

public void dispose()

Description copied from interface: ModuleHandler

The method is called by RuleManager to free resources when ModuleHandler is released.

Specified by:

dispose in interface ModuleHandler

getConfig

protected Configuration getConfig()

Returns the configuration of the module.

Returns:

configuration of the module

getConfigAs

protected <C> C getConfigAs(Class<C> configurationClass)

Returns the configuration of the module and transforms it to the given class.

Parameters:

configurationClass - configuration class

Returns:

configuration of module in form of the given class