Package org.openhab.core.automation.module.script.providersupport.shared

Class ProviderItemChannelLinkRegistry

java.lang.Object

org.openhab.core.automation.module.script.providersupport.shared.ProviderItemChannelLinkRegistry

All Implemented Interfaces:

org.openhab.core.automation.module.script.providersupport.internal.ProviderRegistry, Registry<ItemChannelLink,String>

@NonNullByDefault
public class ProviderItemChannelLinkRegistry
extends Object
implements Registry<ItemChannelLink,String>, org.openhab.core.automation.module.script.providersupport.internal.ProviderRegistry

The ProviderItemChannelLinkRegistry is implementing a Registry to provide a comfortable way to provide ItemChannelLinks from scripts without worrying about the need to remove them again when the script is unloaded. Nonetheless, using the addPermanent(ItemChannelLink) method it is still possible to them permanently.

Use a new instance of this class for each ScriptEngine.

ATTENTION: This class does not provide the same methods as ItemChannelLinkRegistry.

Author:

Florian Hotze - Initial contribution

Constructor Summary

Constructors

Constructor	Description
ProviderItemChannelLinkRegistry(ItemChannelLinkRegistry itemChannelLinkRegistry, ScriptedItemChannelLinkProvider scriptedProvider)

Method Summary

Modifier and Type	Method	Description
ItemChannelLink	add(ItemChannelLink element)	Adds the given element to the according ManagedProvider.
ItemChannelLink	addPermanent(ItemChannelLink element)	Adds an ItemChannelLink permanently to the registry.
void	addRegistryChangeListener(RegistryChangeListener<ItemChannelLink> listener)	Adds a RegistryChangeListener to the registry.
@Nullable ItemChannelLink	get(String key)	This method retrieves a single element from the registry.
Collection<ItemChannelLink>	getAll()	Returns a collection of all elements in the registry.
int	purge()
@Nullable ItemChannelLink	remove(String key)	Removes the given element from the according ManagedProvider.
void	removeAllAddedByScript()	Removes all elements that are provided by the script the ProviderRegistry instance is bound to.
int	removeLinksForItem(String itemName)
int	removeLinksForThing(ThingUID thingUID)
void	removeRegistryChangeListener(RegistryChangeListener<ItemChannelLink> listener)	Removes a RegistryChangeListener from the registry.
Stream<ItemChannelLink>	stream()	Returns a stream of all elements in the registry.
@Nullable ItemChannelLink	update(ItemChannelLink element)	Updates the given element at the according ManagedProvider.

Methods inherited from class java.lang.Object

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

Constructor Details

ProviderItemChannelLinkRegistry

public ProviderItemChannelLinkRegistry(ItemChannelLinkRegistry itemChannelLinkRegistry,
 ScriptedItemChannelLinkProvider scriptedProvider)

Method Details

addRegistryChangeListener

public void addRegistryChangeListener(RegistryChangeListener<ItemChannelLink> listener)

Description copied from interface: Registry

Adds a RegistryChangeListener to the registry.

Specified by:

addRegistryChangeListener in interface Registry<ItemChannelLink,String>

Parameters:

listener - registry change listener

getAll

public Collection<ItemChannelLink> getAll()

Description copied from interface: Registry

Returns a collection of all elements in the registry.

Specified by:

getAll in interface Registry<ItemChannelLink,String>

Returns:

collection of all elements in the registry

stream

public Stream<ItemChannelLink> stream()

Description copied from interface: Registry

Returns a stream of all elements in the registry.

Specified by:

stream in interface Registry<ItemChannelLink,String>

Returns:

stream of all elements in the registry

get

public @Nullable ItemChannelLink get(String key)

Description copied from interface: Registry

This method retrieves a single element from the registry.

Specified by:

get in interface Registry<ItemChannelLink,String>

Parameters:

key - key of the element

Returns:

element or null if no element was found

removeRegistryChangeListener

public void removeRegistryChangeListener(RegistryChangeListener<ItemChannelLink> listener)

Description copied from interface: Registry

Removes a RegistryChangeListener from the registry.

Specified by:

removeRegistryChangeListener in interface Registry<ItemChannelLink,String>

Parameters:

listener - registry change listener

add

public ItemChannelLink add(ItemChannelLink element)

Description copied from interface: Registry

Adds the given element to the according ManagedProvider.

Specified by:

add in interface Registry<ItemChannelLink,String>

Parameters:

element - element to be added (must not be null)

Returns:

the added element or newly created object of the same type

addPermanent

public ItemChannelLink addPermanent(ItemChannelLink element)

Adds an ItemChannelLink permanently to the registry. This ItemChannelLink will be kept in the registry even if the script is unloaded

Parameters:

element - the ItemChannelLink to be added (must not be null)

Returns:

the added ItemChannelLink

update

public @Nullable ItemChannelLink update(ItemChannelLink element)

Description copied from interface: Registry

Updates the given element at the according ManagedProvider.

Specified by:

update in interface Registry<ItemChannelLink,String>

Parameters:

element - element to be updated (must not be null)

Returns:

returns the old element or null if no element with the same key exists

remove

public @Nullable ItemChannelLink remove(String key)

Description copied from interface: Registry

Removes the given element from the according ManagedProvider.

Specified by:

remove in interface Registry<ItemChannelLink,String>

Parameters:

key - key of the element (must not be null)

Returns:

element that was removed, or null if no element with the given key exists

removeLinksForThing

public int removeLinksForThing(ThingUID thingUID)

removeLinksForItem

public int removeLinksForItem(String itemName)

purge

public int purge()

removeAllAddedByScript

public void removeAllAddedByScript()

Description copied from interface: org.openhab.core.automation.module.script.providersupport.internal.ProviderRegistry

Removes all elements that are provided by the script the ProviderRegistry instance is bound to. To be called when the script is unloaded or reloaded.

Specified by:

removeAllAddedByScript in interface org.openhab.core.automation.module.script.providersupport.internal.ProviderRegistry