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

Class ProviderMetadataRegistryDelegate

java.lang.Object

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

All Implemented Interfaces:

ProviderRegistry, Registry<Metadata,MetadataKey>, MetadataRegistry

@NonNullByDefault
public class ProviderMetadataRegistryDelegate
extends Object
implements MetadataRegistry, ProviderRegistry

The ProviderMetadataRegistryDelegate is wrapping a MetadataRegistry to provide a comfortable way to provide items from scripts without worrying about the need to remove metadata again when the script is unloaded. Nonetheless, using the addPermanent(Metadata) method it is still possible to add metadata permanently.

Use a new instance of this class for each ScriptEngine.

Author:

Florian Hotze - Initial contribution

Field Summary

Fields inherited from interface org.openhab.core.items.MetadataRegistry

INTERNAL_NAMESPACE_PREFIX

Constructor Summary

Constructors

Constructor	Description
ProviderMetadataRegistryDelegate(MetadataRegistry metadataRegistry, ScriptedMetadataProvider scriptedProvider)

Method Summary

Modifier and Type	Method	Description
Metadata	add(Metadata element)	Add element to metadata
Metadata	addPermanent(Metadata element)	Adds metadata permanently to the registry.
void	addRegistryChangeListener(RegistryChangeListener<Metadata> listener)	Adds a RegistryChangeListener to the registry.
@Nullable Metadata	get(MetadataKey key)	This method retrieves a single element from the registry.
Collection<Metadata>	getAll()	Returns a collection of all elements in the registry.
Collection<String>	getAllNamespaces(String itemname)	Provides all namespaces of a particular item
boolean	isInternalNamespace(String namespace)	Determines whether the given namespace is internal.
@Nullable Metadata	remove(MetadataKey key)	Remove element from metadata
void	removeAllAddedByScript()	Removes all elements that are provided by the script the ProviderRegistry instance is bound to.
void	removeItemMetadata(String itemname)	Remove all metadata of a given item
void	removeRegistryChangeListener(RegistryChangeListener<Metadata> listener)	Removes a RegistryChangeListener from the registry.
Stream<Metadata>	stream()	Returns a stream of all elements in the registry.
@Nullable Metadata	update(Metadata element)	Update element in metadata

Methods inherited from class java.lang.Object

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

Constructor Details

ProviderMetadataRegistryDelegate

public ProviderMetadataRegistryDelegate(MetadataRegistry metadataRegistry,
 ScriptedMetadataProvider scriptedProvider)

Method Details

addRegistryChangeListener

public void addRegistryChangeListener(RegistryChangeListener<Metadata> listener)

Description copied from interface: Registry

Adds a RegistryChangeListener to the registry.

Specified by:

addRegistryChangeListener in interface Registry<Metadata,MetadataKey>

Parameters:

listener - registry change listener

getAll

public Collection<Metadata> getAll()

Description copied from interface: Registry

Returns a collection of all elements in the registry.

Specified by:

getAll in interface Registry<Metadata,MetadataKey>

Returns:

collection of all elements in the registry

stream

public Stream<Metadata> stream()

Description copied from interface: Registry

Returns a stream of all elements in the registry.

Specified by:

stream in interface Registry<Metadata,MetadataKey>

Returns:

stream of all elements in the registry

get

public @Nullable Metadata get(MetadataKey key)

Description copied from interface: Registry

This method retrieves a single element from the registry.

Specified by:

get in interface Registry<Metadata,MetadataKey>

Parameters:

key - key of the element

Returns:

element or null if no element was found

removeRegistryChangeListener

public void removeRegistryChangeListener(RegistryChangeListener<Metadata> listener)

Description copied from interface: Registry

Removes a RegistryChangeListener from the registry.

Specified by:

removeRegistryChangeListener in interface Registry<Metadata,MetadataKey>

Parameters:

listener - registry change listener

add

public Metadata add(Metadata element)

Description copied from interface: MetadataRegistry

Add element to metadata

Specified by:

add in interface MetadataRegistry

Specified by:

add in interface Registry<Metadata,MetadataKey>

Parameters:

element - the element to add (must not be null)

Returns:

the added element or newly created object of the same type

addPermanent

public Metadata addPermanent(Metadata element)

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

Parameters:

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

Returns:

the added metadata

update

public @Nullable Metadata update(Metadata element)

Description copied from interface: MetadataRegistry

Update element in metadata

Specified by:

update in interface MetadataRegistry

Specified by:

update in interface Registry<Metadata,MetadataKey>

Parameters:

element - the element to update (must not be null)

Returns:

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

remove

public @Nullable Metadata remove(MetadataKey key)

Description copied from interface: MetadataRegistry

Remove element from metadata

Specified by:

remove in interface MetadataRegistry

Specified by:

remove in interface Registry<Metadata,MetadataKey>

Parameters:

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

Returns:

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

isInternalNamespace

public boolean isInternalNamespace(String namespace)

Description copied from interface: MetadataRegistry

Determines whether the given namespace is internal.

Specified by:

isInternalNamespace in interface MetadataRegistry

Parameters:

namespace - the metadata namespace to check

Returns:

true if the given namespace is internal, false otherwise

getAllNamespaces

public Collection<String> getAllNamespaces(String itemname)

Description copied from interface: MetadataRegistry

Provides all namespaces of a particular item

Specified by:

getAllNamespaces in interface MetadataRegistry

Parameters:

itemname - the name of the item for which the namespaces should be searched.

removeItemMetadata

public void removeItemMetadata(String itemname)

Description copied from interface: MetadataRegistry

Remove all metadata of a given item

Specified by:

removeItemMetadata in interface MetadataRegistry

Parameters:

itemname - the name of the item for which the metadata is to be removed.

removeAllAddedByScript

public void removeAllAddedByScript()

Description copied from interface: 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 ProviderRegistry