Package org.openhab.core.items

Interface MetadataRegistry

All Superinterfaces:

Registry<Metadata,MetadataKey>

All Known Implementing Classes:

ProviderMetadataRegistryDelegate

@NonNullByDefault
public interface MetadataRegistry
extends Registry<Metadata,MetadataKey>

The MetadataRegistry is the central place, where additional information about items is kept. Metadata can be supplied by MetadataProviders, which can provision them from any source they like and also dynamically remove or add data.

Author:

Kai Kreuzer - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERNAL_NAMESPACE_PREFIX

Method Summary

Modifier and Type	Method	Description
Metadata	add(Metadata element)	Add element to metadata
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	removeItemMetadata(String itemname)	Remove all metadata of a given item
@Nullable Metadata	update(Metadata element)	Update element in metadata

Methods inherited from interface org.openhab.core.common.registry.Registry

addRegistryChangeListener, get, getAll, removeRegistryChangeListener, stream

Field Details

INTERNAL_NAMESPACE_PREFIX

static final String INTERNAL_NAMESPACE_PREFIX

See Also:

• Constant Field Values

Method Details

isInternalNamespace

boolean isInternalNamespace(String namespace)

Determines whether the given namespace is internal.

Parameters:

namespace - the metadata namespace to check

Returns:

true if the given namespace is internal, false otherwise

getAllNamespaces

Collection<String> getAllNamespaces(String itemname)

Provides all namespaces of a particular item

Parameters:

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

removeItemMetadata

void removeItemMetadata(String itemname)

Remove all metadata of a given item

Parameters:

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

add

Metadata add(Metadata element)

Add element to metadata

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

Throws:

UnsupportedOperationException - if the metadata namespace has a reserved MetadataProvider that is not a ManagedProvider

IllegalStateException - if no ManagedProvider is available

update

@Nullable Metadata update(Metadata element)

Update element in metadata

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

Throws:

UnsupportedOperationException - if the metadata namespace has a reserved MetadataProvider that is not a ManagedProvider

IllegalStateException - if no ManagedProvider is available

remove

@Nullable Metadata remove(MetadataKey key)

Remove element from metadata

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

Throws:

UnsupportedOperationException - if the metadata namespace has a reserved MetadataProvider that is not a ManagedProvider

IllegalStateException - if no ManagedProvider is available