org.hippoecm.hst.core.pagemodel.model

Interface MetadataContributable

public interface MetadataContributable

Interface for an abstraction to be able to contribute metadata.

Method Summary

Modifier and Type	Method and Description
void	clearMetadataMap() Removes all the items in the metadata map.
Object	getMetadata(String name) Get the metadata value by the name, or null if not found.
Map<String,Object>	getMetadataMap() Return unmodifiable metadata map.
void	putMetadata(String name, Object value) Put a metadata, value, by the name.
Object	removeMetadata(String name) Remove the existing metadata value by the name and return the old metadata value if removed.

Method Detail

getMetadataMap

Map<String,Object> getMetadataMap()

Return unmodifiable metadata map.

Returns:

unmodifiable metadata map

putMetadata

void putMetadata(String name,
                 Object value)

Put a metadata, value, by the name.

Parameters:

name - metadata name

value - metadata value

getMetadata

Object getMetadata(String name)

Get the metadata value by the name, or null if not found.

Parameters:

name - metadata name

Returns:

metadata value, or null if not found.

removeMetadata

Object removeMetadata(String name)

Remove the existing metadata value by the name and return the old metadata value if removed. Or null if nothing was removed.

Parameters:

name -

Returns:

clearMetadataMap

void clearMetadataMap()

Removes all the items in the metadata map.