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

Class ScriptedMetadataProvider

java.lang.Object

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

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

All Implemented Interfaces:

ManagedProvider<Metadata,MetadataKey>, Provider<Metadata>, ManagedMetadataProvider, MetadataProvider

@NonNullByDefault
public class ScriptedMetadataProvider
extends AbstractProvider<Metadata>
implements ManagedMetadataProvider

This MetadataProvider keeps metadata provided by scripts during runtime. This ensures that metadata is not kept on reboot, but has 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
ScriptedMetadataProvider()

Method Summary

Modifier and Type	Method	Description
void	add(Metadata metadata)	Adds an element.
@Nullable Metadata	get(MetadataKey metadataKey)	Returns an element for the given key or null if no element for the given key exists.
Collection<Metadata>	getAll()	Returns a collection of all elements.
@Nullable Metadata	remove(MetadataKey metadataKey)	Removes an element and returns the removed element.
void	removeItemMetadata(String name)	Removes all metadata of a given item
@Nullable Metadata	update(Metadata metadata)	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

ScriptedMetadataProvider

public ScriptedMetadataProvider()

Method Details

removeItemMetadata

public void removeItemMetadata(String name)

Description copied from interface: ManagedMetadataProvider

Removes all metadata of a given item

Specified by:

removeItemMetadata in interface ManagedMetadataProvider

Parameters:

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

getAll

public Collection<Metadata> getAll()

Description copied from interface: Provider

Returns a collection of all elements.

Specified by:

getAll in interface Provider<Metadata>

Returns:

collection of all elements

get

public @Nullable Metadata get(MetadataKey metadataKey)

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<Metadata,MetadataKey>

Parameters:

metadataKey - key

Returns:

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

add

public void add(Metadata metadata)

Description copied from interface: ManagedProvider

Adds an element.

Specified by:

add in interface ManagedProvider<Metadata,MetadataKey>

Parameters:

metadata - element to be added

update

public @Nullable Metadata update(Metadata metadata)

Description copied from interface: ManagedProvider

Updates an element.

Specified by:

update in interface ManagedProvider<Metadata,MetadataKey>

Parameters:

metadata - element to be updated

Returns:

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

remove

public @Nullable Metadata remove(MetadataKey metadataKey)

Description copied from interface: ManagedProvider

Removes an element and returns the removed element.

Specified by:

remove in interface ManagedProvider<Metadata,MetadataKey>

Parameters:

metadataKey - key of the element that should be removed

Returns:

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