MetaDataSupporter (adams-pom 24.12.0-SNAPSHOT API)

All Known Implementing Classes:

Binnable
```
public interface MetaDataSupporter
```
Interface for objects that support meta-data.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Object`	`addMetaData(String key, Object value)`	Adds a key-value pair to the meta-data store.
`Map<String,Object>`	`getMetaData()`	Returns the meta-data store.
`Object`	`getMetaData(String key)`	Returns the specified value from the meta-data store.
`Set<String>`	`metaDataKeys()`	Returns the set of meta-data keys.
`Object`	`removeMetaData(String key)`	Removes a key-value pair from the meta-data store.

- Method Detail
  - addMetaData
```
Object addMetaData(String key,
                   Object value)
```
    Adds a key-value pair to the meta-data store.
    
    Parameters:
    
    key - the key to store the value for
    
    value - the value to store
    
    Returns:
    
    any previously stored object for this key, otherwise null
  - removeMetaData
```
Object removeMetaData(String key)
```
    Removes a key-value pair from the meta-data store.
    
    Parameters:
    
    key - the key to remove the value for
    
    Returns:
    
    any previously stored object for this key, null if none was present
  - getMetaData
```
Object getMetaData(String key)
```
    Returns the specified value from the meta-data store.
    
    Parameters:
    
    key - the key to retrieve the value for
    
    Returns:
    
    stored object for this key, null if none was present
  - getMetaData
```
Map<String,Object> getMetaData()
```
    Returns the meta-data store.
    
    Returns:
    
    the meta-data
  - metaDataKeys
```
Set<String> metaDataKeys()
```
    Returns the set of meta-data keys.
    
    Returns:
    
    the meta-data keys