Package org.openhab.core.transform

Class ManagedTransformationConfigurationProvider

java.lang.Object

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

org.openhab.core.common.registry.AbstractManagedProvider<TransformationConfiguration,String,ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration>

org.openhab.core.transform.ManagedTransformationConfigurationProvider

All Implemented Interfaces:

ManagedProvider<TransformationConfiguration,String>, Provider<TransformationConfiguration>, TransformationConfigurationProvider

@NonNullByDefault
public class ManagedTransformationConfigurationProvider
extends AbstractManagedProvider<TransformationConfiguration,String,ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration>
implements TransformationConfigurationProvider

The ManagedTransformationConfigurationProvider implements a TransformationConfigurationProvider for managed configurations stored in a JSON database

Author:

Jan N. Klug - Initial contribution

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration

Field Summary

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

logger

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

listeners

Constructor Summary

Constructors

Constructor	Description
ManagedTransformationConfigurationProvider(StorageService storageService)

Method Summary

Modifier and Type	Method	Description
void	add(TransformationConfiguration element)	Adds an element.
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.
protected @Nullable TransformationConfiguration	toElement(String key, ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration persistableElement)	Converts the persistable element into the original element.
protected ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration	toPersistableElement(TransformationConfiguration element)	Converts the original element into an element that can be persisted.
@Nullable TransformationConfiguration	update(TransformationConfiguration element)	Updates an element.

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

get, getAll, remove

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 Detail

ManagedTransformationConfigurationProvider

public ManagedTransformationConfigurationProvider(StorageService storageService)

Method Detail

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<TransformationConfiguration,String,ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration>

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<TransformationConfiguration,String,ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration>

Parameters:

key - key

Returns:

string representation of the key

toElement

protected @Nullable TransformationConfiguration toElement(String key,
                                                          ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration persistableElement)

Description copied from class: AbstractManagedProvider

Converts the persistable element into the original element.

Specified by:

toElement in class AbstractManagedProvider<TransformationConfiguration,String,ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration>

Parameters:

key - key

persistableElement - persistable element

Returns:

original element

toPersistableElement

protected ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration toPersistableElement(TransformationConfiguration element)

Description copied from class: AbstractManagedProvider

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

Specified by:

toPersistableElement in class AbstractManagedProvider<TransformationConfiguration,String,ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration>

Parameters:

element - original element

Returns:

persistable element

add

public void add(TransformationConfiguration element)

Description copied from interface: ManagedProvider

Adds an element.

Specified by:

add in interface ManagedProvider<TransformationConfiguration,String>

Overrides:

add in class AbstractManagedProvider<TransformationConfiguration,String,ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration>

Parameters:

element - element to be added

update

public @Nullable TransformationConfiguration update(TransformationConfiguration element)

Description copied from interface: ManagedProvider

Updates an element.

Specified by:

update in interface ManagedProvider<TransformationConfiguration,String>

Overrides:

update in class AbstractManagedProvider<TransformationConfiguration,String,ManagedTransformationConfigurationProvider.PersistedTransformationConfiguration>

Parameters:

element - element to be updated

Returns:

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