com.sitewhere.rest.model.common

Class MetadataProvider

java.lang.Object

com.sitewhere.rest.model.common.MetadataProvider

All Implemented Interfaces:

IMetadataProvider, java.io.Serializable

Direct Known Subclasses:

BatchElement, DeviceCommandInvocationSummary, DeviceEvent, MetadataProviderEntity, SiteMapData, TenantCreateRequest, TenantGroupCreateRequest, UserCreateRequest

public class MetadataProvider
extends java.lang.Object
implements IMetadataProvider, java.io.Serializable

Holds arbitrary metadata associated with an entity.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetadataProvider()

Method Summary

Modifier and Type	Method and Description
void	addOrReplaceMetadata(java.lang.String name, java.lang.String value) Add or replace a metadata field.
void	clearMetadata() Clear existing metadata.
static void	copy(IMetadataProvider source, MetadataProvider target) Copy contents of one metadata provider to another.
static void	copy(java.util.Map<java.lang.String,java.lang.String> source, MetadataProvider target) Copy values from a map into a MetadataProvider.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Get a map of all metadata.
java.lang.String	getMetadata(java.lang.String name) Get value of metadata field.
java.lang.String	removeMetadata(java.lang.String name) Remove a metadata field.
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> entries)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataProvider

public MetadataProvider()

Method Detail

addOrReplaceMetadata

public void addOrReplaceMetadata(java.lang.String name,
                                 java.lang.String value)
                          throws SiteWhereException

Description copied from interface: IMetadataProvider

Add or replace a metadata field.

Specified by:

addOrReplaceMetadata in interface IMetadataProvider

Throws:

SiteWhereException

removeMetadata

public java.lang.String removeMetadata(java.lang.String name)

Description copied from interface: IMetadataProvider

Remove a metadata field.

Specified by:

removeMetadata in interface IMetadataProvider

Returns:

getMetadata

public java.lang.String getMetadata(java.lang.String name)

Description copied from interface: IMetadataProvider

Get value of metadata field.

Specified by:

getMetadata in interface IMetadataProvider

Returns:

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Description copied from interface: IMetadataProvider

Get a map of all metadata.

Specified by:

getMetadata in interface IMetadataProvider

Returns:

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> entries)

clearMetadata

public void clearMetadata()

Description copied from interface: IMetadataProvider

Clear existing metadata.

Specified by:

clearMetadata in interface IMetadataProvider

copy

public static void copy(IMetadataProvider source,
                        MetadataProvider target)
                 throws SiteWhereException

Copy contents of one metadata provider to another.

Parameters:

source -

target -

Throws:

SiteWhereException

copy

public static void copy(java.util.Map<java.lang.String,java.lang.String> source,
                        MetadataProvider target)
                 throws SiteWhereException

Copy values from a map into a MetadataProvider.

Parameters:

source -

target -

Throws:

SiteWhereException