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

Class ScriptedItemChannelLinkProvider

java.lang.Object

org.openhab.core.common.registry.AbstractProvider<ItemChannelLink>

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

All Implemented Interfaces:

ManagedProvider<ItemChannelLink,String>, Provider<ItemChannelLink>, ItemChannelLinkProvider

@NonNullByDefault
public class ScriptedItemChannelLinkProvider
extends AbstractProvider<ItemChannelLink>
implements ItemChannelLinkProvider, ManagedProvider<ItemChannelLink,String>

This ItemChannelLinkProvider keeps ItemChannelLinks provided by scripts during runtime. This ensures that ItemChannelLinks are not kept on reboot, but have to be provided by the scripts again.

Author:

Florian Hotze - Initial contribution

Field Summary

Fields inherited from class org.openhab.core.common.registry.AbstractProvider

listeners

Constructor Summary

Constructors

Constructor	Description
ScriptedItemChannelLinkProvider()

Method Summary

Modifier and Type	Method	Description
void	add(ItemChannelLink itemChannelLink)	Adds an element.
@Nullable ItemChannelLink	get(String key)	Returns an element for the given key or null if no element for the given key exists.
Collection<ItemChannelLink>	getAll()	Returns a collection of all elements.
@Nullable ItemChannelLink	remove(String key)	Removes an element and returns the removed element.
@Nullable ItemChannelLink	update(ItemChannelLink itemChannelLink)	Updates an element.

Methods inherited from class org.openhab.core.common.registry.AbstractProvider

addProviderChangeListener, notifyListenersAboutAddedElement, notifyListenersAboutRemovedElement, notifyListenersAboutUpdatedElement, removeProviderChangeListener

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.common.registry.Provider

addProviderChangeListener, removeProviderChangeListener

Constructor Details

ScriptedItemChannelLinkProvider

public ScriptedItemChannelLinkProvider()

Method Details

getAll

public Collection<ItemChannelLink> getAll()

Description copied from interface: Provider

Returns a collection of all elements.

Specified by:

getAll in interface Provider<ItemChannelLink>

Returns:

collection of all elements

get

public @Nullable ItemChannelLink get(String key)

Description copied from interface: ManagedProvider

Returns an element for the given key or null if no element for the given key exists.

Specified by:

get in interface ManagedProvider<ItemChannelLink,String>

Parameters:

key - key

Returns:

returns element or null, if no element for the given key exists

add

public void add(ItemChannelLink itemChannelLink)

Description copied from interface: ManagedProvider

Adds an element.

Specified by:

add in interface ManagedProvider<ItemChannelLink,String>

Parameters:

itemChannelLink - element to be added

update

public @Nullable ItemChannelLink update(ItemChannelLink itemChannelLink)

Description copied from interface: ManagedProvider

Updates an element.

Specified by:

update in interface ManagedProvider<ItemChannelLink,String>

Parameters:

itemChannelLink - element to be updated

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: ManagedProvider

Removes an element and returns the removed element.

Specified by:

remove in interface ManagedProvider<ItemChannelLink,String>

Parameters:

key - key of the element that should be removed

Returns:

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