Package org.openhab.core.items

Class ManagedItemProvider

java.lang.Object

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

org.openhab.core.common.registry.AbstractManagedProvider<Item,String,ManagedItemProvider.PersistedItem>

org.openhab.core.items.ManagedItemProvider

All Implemented Interfaces:

ManagedProvider<Item,String>, Provider<@NonNull Item>, ItemProvider

@NonNullByDefault
public class ManagedItemProvider
extends AbstractManagedProvider<Item,String,ManagedItemProvider.PersistedItem>
implements ItemProvider

ManagedItemProvider is an OSGi service, that allows to add or remove items at runtime by calling ManagedItemProvider#addItem(Item) or ManagedItemProvider#removeItem(Item) . An added item is automatically exposed to the ItemRegistry. Persistence of added Items is handled by a StorageService. Items are being restored using the given ItemFactorys.

Author:

Dennis Nobel - Initial contribution, added support for GroupItems, Thomas Eichstaedt-Engelen - Initial contribution, Kai Kreuzer - improved return values, Alex Tugarev - added tags

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagedItemProvider.PersistedItem

Field Summary

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

listeners

Constructor Summary

Constructors

Constructor	Description
ManagedItemProvider(StorageService storageService, ItemBuilderFactory itemBuilderFactory)

Method Summary

Modifier and Type	Method	Description
void	add(Item element)	Adds an element.
protected void	addItemFactory(ItemFactory itemFactory)
protected String	getStorageName()	Returns the name of storage, that is used to persist the elements.
protected String	keyToString(String key)	Transforms the key into a string representation.
@Nullable Item	remove(String key)	Removes an element and returns the removed element.
@Nullable Item	remove(String itemName, boolean recursive)	Removes an item and its member if recursive flag is set to true.
protected void	removeItemFactory(ItemFactory itemFactory)
protected @Nullable Item	toElement(String itemName, ManagedItemProvider.PersistedItem persistedItem)	Converts the persistable element into the original element.
protected ManagedItemProvider.PersistedItem	toPersistableElement(Item item)	Converts the original element into an element that can be persisted.

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

get, getAll, update

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, getAll, removeProviderChangeListener

Constructor Details

ManagedItemProvider

public ManagedItemProvider(StorageService storageService,
 ItemBuilderFactory itemBuilderFactory)

Method Details

remove

public @Nullable Item remove(String key)

Description copied from interface: ManagedProvider

Removes an element and returns the removed element.

Specified by:

remove in interface ManagedProvider<Item,String>

Overrides:

remove in class AbstractManagedProvider<Item,String,ManagedItemProvider.PersistedItem>

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

remove

public @Nullable Item remove(String itemName,
 boolean recursive)

Removes an item and its member if recursive flag is set to true.

Parameters:

itemName - item name to remove

recursive - if set to true all members of the item will be removed, too.

Returns:

removed item or null if no item with that name exists

add

public void add(Item element)

Description copied from interface: ManagedProvider

Adds an element.

Specified by:

add in interface ManagedProvider<Item,String>

Overrides:

add in class AbstractManagedProvider<Item,String,ManagedItemProvider.PersistedItem>

Parameters:

element - element to be added

addItemFactory

protected void addItemFactory(ItemFactory itemFactory)

removeItemFactory

protected void removeItemFactory(ItemFactory itemFactory)

getStorageName

protected String getStorageName()

Description copied from class: AbstractManagedProvider

Returns the name of storage, that is used to persist the elements.

Specified by:

getStorageName in class AbstractManagedProvider<Item,String,ManagedItemProvider.PersistedItem>

Returns:

name of the storage

keyToString

protected String keyToString(String key)

Description copied from class: AbstractManagedProvider

Transforms the key into a string representation.

Specified by:

keyToString in class AbstractManagedProvider<Item,String,ManagedItemProvider.PersistedItem>

Parameters:

key - key

Returns:

string representation of the key

toElement

protected @Nullable Item toElement(String itemName,
 ManagedItemProvider.PersistedItem persistedItem)

Description copied from class: AbstractManagedProvider

Converts the persistable element into the original element.

Specified by:

toElement in class AbstractManagedProvider<Item,String,ManagedItemProvider.PersistedItem>

Parameters:

itemName - key

persistedItem - persistable element

Returns:

original element

toPersistableElement

protected ManagedItemProvider.PersistedItem toPersistableElement(Item item)

Description copied from class: AbstractManagedProvider

Converts the original element into an element that can be persisted.

Specified by:

toPersistableElement in class AbstractManagedProvider<Item,String,ManagedItemProvider.PersistedItem>

Parameters:

item - original element

Returns:

persistable element