Package org.anchoranalysis.mpp.io.input

Interface MultiInputSubMap<T>

Type Parameters:

T - the type of objects stored in the map

All Known Implementing Classes:

OperationMap, StackWithMap

public interface MultiInputSubMap<T>

A sub-item of a MultiInput that manages a map of objects.

This interface provides methods to:

1. Add entries to the map.
2. Copy the contents of the map into a NamedProviderStore.
3. Retrieve entries from the map.

Method Summary

Modifier and Type	Method	Description
void	add(String name, StoreSupplier<T> supplier)	Adds an entry to the map.
void	addToStore(NamedProviderStore<T> namedStore, Logger logger)	Copies all the existing entries into a NamedProviderStore.
StoreSupplier<T>	get(String name)	Retrieves an entry from the map.

Method Details

add

void add(String name,
 StoreSupplier<T> supplier)

Adds an entry to the map.

Parameters:

name - the name of the entry

supplier - the supplier for the entry's value

addToStore

void addToStore(NamedProviderStore<T> namedStore,
 Logger logger)
         throws OperationFailedException

Copies all the existing entries into a NamedProviderStore.

Parameters:

namedStore - the store to copy the entries into

logger - a logger for any non-fatal errors

Throws:

OperationFailedException - if a fatal error occurs during the copy process

get

StoreSupplier<T> get(String name)
              throws OperationFailedException

Retrieves an entry from the map.

Parameters:

name - the name of the entry to retrieve

Returns:

the StoreSupplier for the entry, or null if the entry doesn't exist

Throws:

OperationFailedException - if an error occurs while retrieving the entry