org.mule.runtime.api.store

Class TemplateObjectStore<T extends Serializable>

java.lang.Object

org.mule.runtime.api.store.AbstractObjectStoreSupport<T>

org.mule.runtime.api.store.TemplateObjectStore<T>

All Implemented Interfaces:

ObjectStore<T>

Direct Known Subclasses:

SimpleMemoryObjectStore

public abstract class TemplateObjectStore<T extends Serializable>
extends AbstractObjectStoreSupport<T>

Template for ObjectStore implementations so that it's easier to conform to the contract.

ObjectStore implementations are not required to extend this class, but it is recommended to do so in order to help guaranteeing that implementations implement the contract correctly.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
TemplateObjectStore()

Method Summary

Modifier and Type	Method and Description
boolean	contains(String key) Check whether this store already contains a value for the given key
protected abstract boolean	doContains(String key) Template method for contains(String).
protected abstract T	doRemove(String key) Template method for remove(String) (String, Serializable)}.
protected abstract T	doRetrieve(String key) Template method for store(String, Serializable).
protected abstract void	doStore(String key, T value) Template method for store(String, Serializable).
T	remove(String key) Remove the object with the given key
T	retrieve(String key) * Retrieve the object stored under the given key
void	store(String key, T value) Store the given Object.

Methods inherited from class org.mule.runtime.api.store.AbstractObjectStoreSupport

validateKey, validatePresentKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.api.store.ObjectStore

allKeys, clear, close, isPersistent, open, retrieveAll

Constructor Detail

TemplateObjectStore

public TemplateObjectStore()

Method Detail

contains

public boolean contains(String key)
                 throws ObjectStoreException

Check whether this store already contains a value for the given key

Parameters:

key - the identifier of the object to check

Returns:

true if the key is stored or false no value was stored for the key.

Throws:

ObjectStoreException - if the given key is null.

ObjectStoreNotAvailableException - if any implementation-specific error occured, e.g. when the store is not available

doContains

protected abstract boolean doContains(String key)
                               throws ObjectStoreException

Template method for contains(String). Implement this method assuming that the key is already valid

Throws:

ObjectStoreException

store

public void store(String key,
                  T value)
           throws ObjectStoreException

Store the given Object.

Parameters:

key - the identifier for value

value - the Object to store with key

Throws:

ObjectStoreException - if the given key cannot be stored or is null.

ObjectStoreNotAvailableException - if the store is not available or any other implementation-specific error occured.

ObjectAlreadyExistsException - if an attempt is made to store an object for a key that already has an object associated.

doStore

protected abstract void doStore(String key,
                                T value)
                         throws ObjectStoreException

Template method for store(String, Serializable). Implement this method assuming that the key is valid and that contains(String) has already been invoked to verify that the key doesn't already exists in this store.

Throws:

ObjectStoreException

retrieve

public T retrieve(String key)
           throws ObjectStoreException

* Retrieve the object stored under the given key

Parameters:

key - the identifier of the object to retrieve.

Returns:

the object associated with the given key. If no object for the given key was found this method throws an ObjectDoesNotExistException.

Throws:

ObjectStoreException - if the given key is null.

ObjectStoreNotAvailableException - if the store is not available or any other implementation-specific error occured.

ObjectDoesNotExistException - if no value for the given key was previously stored.

doRetrieve

protected abstract T doRetrieve(String key)
                         throws ObjectStoreException

Template method for store(String, Serializable). Implement this method assuming that the key is valid and that contains(String) has already been invoked to verify that the key actually exists in this store.

Throws:

ObjectStoreException

remove

public T remove(String key)
         throws ObjectStoreException

Remove the object with the given key

Parameters:

key - the identifier of the object to remove.

Returns:

the object that was previously stored for the given key

Throws:

ObjectStoreException - if the given key is null or if the store is not available or any other implementation-specific error occured

ObjectDoesNotExistException - if no value for the given key was previously stored.

doRemove

protected abstract T doRemove(String key)
                       throws ObjectStoreException

Template method for remove(String) (String, Serializable)}. Implement this method assuming that the key is valid and that contains(String) has already been invoked to verify that the key actually exists in this store.

Throws:

ObjectStoreException