Package org.openhab.core.automation.thingsupport

Class AnnotatedThingActionModuleTypeProvider

java.lang.Object

org.openhab.core.automation.handler.BaseModuleHandlerFactory

org.openhab.core.automation.thingsupport.AnnotatedThingActionModuleTypeProvider

All Implemented Interfaces:

ModuleHandlerFactory, ModuleTypeProvider, Provider<ModuleType>

@NonNullByDefault
public class AnnotatedThingActionModuleTypeProvider
extends BaseModuleHandlerFactory
implements ModuleTypeProvider

ModuleTypeProvider that collects actions for ThingHandlers

Author:

Stefan Triller - Initial contribution, Laurent Garnier - Injected components AnnotationActionModuleTypeHelper and ActionInputsHelper

Constructor Summary

Constructors

Constructor	Description
AnnotatedThingActionModuleTypeProvider(ModuleTypeI18nService moduleTypeI18nService, AnnotationActionModuleTypeHelper helper, ActionInputsHelper actionInputsHelper)

Method Summary

Modifier and Type	Method	Description
void	addAnnotatedThingActions(ThingActions annotatedThingActions)
void	addProviderChangeListener(ProviderChangeListener<ModuleType> listener)	Adds a ProviderChangeListener which must be notified if there are changes concerning the elements provided by the Provider.
protected void	deactivate()	Should be overridden by the implementations that extend this base class.
Collection<ModuleType>	getAll()	Returns a collection of all elements.
<T extends ModuleType> T	getModuleType(String uid, @Nullable Locale locale)	Gets the localized ModuleType defined by this provider.
<T extends ModuleType> Collection<T>	getModuleTypes(@Nullable Locale locale)	Gets the localized ModuleTypes defined by this provider.
Collection<String>	getTypes()	Returns the UIDs of the module types currently supported by this factory.
protected @Nullable ModuleHandler	internalCreate(Module module, String ruleUID)	Creates a new ModuleHandler for a given module and ruleUID.
void	removeAnnotatedThingActions(ThingActions annotatedThingActions)
void	removeProviderChangeListener(ProviderChangeListener<ModuleType> listener)	Removes a ProviderChangeListener.

Methods inherited from class org.openhab.core.automation.handler.BaseModuleHandlerFactory

getHandler, getHandlers, getModuleIdentifier, ungetHandler

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotatedThingActionModuleTypeProvider

public AnnotatedThingActionModuleTypeProvider(ModuleTypeI18nService moduleTypeI18nService,
 AnnotationActionModuleTypeHelper helper,
 ActionInputsHelper actionInputsHelper)

Method Details

deactivate

protected void deactivate()

Description copied from class: BaseModuleHandlerFactory

Should be overridden by the implementations that extend this base class. Called from DS to deactivate the ModuleHandlerFactory.

Overrides:

deactivate in class BaseModuleHandlerFactory

addProviderChangeListener

public void addProviderChangeListener(ProviderChangeListener<ModuleType> listener)

Description copied from interface: Provider

Adds a ProviderChangeListener which must be notified if there are changes concerning the elements provided by the Provider.

Specified by:

addProviderChangeListener in interface Provider<ModuleType>

Parameters:

listener - the listener to be added

removeProviderChangeListener

public void removeProviderChangeListener(ProviderChangeListener<ModuleType> listener)

Description copied from interface: Provider

Removes a ProviderChangeListener.

Specified by:

removeProviderChangeListener in interface Provider<ModuleType>

Parameters:

listener - the listener to be removed.

getAll

public Collection<ModuleType> getAll()

Description copied from interface: Provider

Returns a collection of all elements.

Specified by:

getAll in interface Provider<ModuleType>

Returns:

collection of all elements

getModuleType

public <T extends ModuleType> T getModuleType(String uid,
 @Nullable Locale locale)

Description copied from interface: ModuleTypeProvider

Gets the localized ModuleType defined by this provider. When the localization is not specified or it is not supported a ModuleType with default locale is returned.

Specified by:

getModuleType in interface ModuleTypeProvider

Type Parameters:

T - the type of the required object.

Parameters:

uid - unique identifier of the ModuleType.

locale - defines localization of label and description of the ModuleType or null.

Returns:

localized module type.

getModuleTypes

public <T extends ModuleType> Collection<T> getModuleTypes(@Nullable Locale locale)

Description copied from interface: ModuleTypeProvider

Gets the localized ModuleTypes defined by this provider. When localization is not specified or it is not supported the ModuleTypes with default localization is returned.

Specified by:

getModuleTypes in interface ModuleTypeProvider

Type Parameters:

T - the type of the required object.

Parameters:

locale - defines localization of label and description of the ModuleTypes or null.

Returns:

collection of localized ModuleType provided by this provider.

addAnnotatedThingActions

public void addAnnotatedThingActions(ThingActions annotatedThingActions)

removeAnnotatedThingActions

public void removeAnnotatedThingActions(ThingActions annotatedThingActions)

getTypes

public Collection<String> getTypes()

Description copied from interface: ModuleHandlerFactory

Returns the UIDs of the module types currently supported by this factory. A ModuleHandlerFactory instance can add new types to this list, but should not remove. If a module type is no longer supported, the ModuleHandlerFactory service must be unregistered, and then registered again with the new list.

If two or more ModuleHandlerFactorys support the same module type, the Rule Engine will choose one of them randomly. Once a factory is chosen, it will be used to create instances of this module type until its service is unregistered.

Specified by:

getTypes in interface ModuleHandlerFactory

Returns:

collection of module type UIDs supported by this factory.

internalCreate

protected @Nullable ModuleHandler internalCreate(Module module,
 String ruleUID)

Description copied from class: BaseModuleHandlerFactory

Creates a new ModuleHandler for a given module and ruleUID.

Specified by:

internalCreate in class BaseModuleHandlerFactory

Parameters:

module - the Module for which a handler should be created.

ruleUID - the identifier of the Rule that the given module belongs to.

Returns:

a ModuleHandler instance or null if this module type is not supported.