org.mule.util.store
Class ObjectStorePartition<T extends Serializable>

java.lang.Object
  org.mule.util.store.ObjectStorePartition<T>

All Implemented Interfaces:

ListableObjectStore<T>, ObjectStore<T>

public class ObjectStorePartition<T extends Serializable>
extends Object
implements ListableObjectStore<T>

Constructor Summary

ObjectStorePartition(String partitionName, PartitionableObjectStore<T> partitionedObjectStore)

Method Summary

List<Serializable>	allKeys()
void	close() Close the underlying store.
boolean	contains(Serializable key) Check whether the given Object is already registered with this store.
PartitionableObjectStore<T>	getBaseStore()
String	getPartitionName()
boolean	isPersistent() Is this store persistent?
void	open() Open the underlying store.
T	remove(Serializable key) Remove the object with key.
T	retrieve(Serializable key) Retrieve the given Object.
void	store(Serializable key, T value) Store the given Object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectStorePartition

public ObjectStorePartition(String partitionName,
                            PartitionableObjectStore<T> partitionedObjectStore)

Method Detail

contains

public boolean contains(Serializable key)
                 throws ObjectStoreException

Description copied from interface: ObjectStore

Check whether the given Object is already registered with this store.

Specified by:

contains in interface ObjectStore<T extends Serializable>

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.

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

store

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

Description copied from interface: ObjectStore

Store the given Object.

Specified by:

store in interface ObjectStore<T extends Serializable>

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.

ObjectStoreNotAvaliableException - 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.

retrieve

public T retrieve(Serializable key)
                                throws ObjectStoreException

Description copied from interface: ObjectStore

Retrieve the given Object.

Specified by:

retrieve in interface ObjectStore<T extends Serializable>

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.

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

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

remove

public T remove(Serializable key)
                              throws ObjectStoreException

Description copied from interface: ObjectStore

Remove the object with key.

Specified by:

remove in interface ObjectStore<T extends Serializable>

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.

isPersistent

public boolean isPersistent()

Description copied from interface: ObjectStore

Is this store persistent?

Specified by:

isPersistent in interface ObjectStore<T extends Serializable>

Returns:

true if this store is persistent

open

public void open()
          throws ObjectStoreException

Description copied from interface: ListableObjectStore

Open the underlying store.

Specified by:

open in interface ListableObjectStore<T extends Serializable>

Throws:

ObjectStoreException - if an exception occurred while opening the underlying store.

close

public void close()
           throws ObjectStoreException

Description copied from interface: ListableObjectStore

Close the underlying store.

Specified by:

close in interface ListableObjectStore<T extends Serializable>

Throws:

ObjectStoreException - if an exception occurred while closing the underlying store.

allKeys

public List<Serializable> allKeys()
                           throws ObjectStoreException

Specified by:

allKeys in interface ListableObjectStore<T extends Serializable>

Returns:

list containing all keys that this object store currently holds values for.

Throws:

ObjectStoreException - if an exception occurred while collecting the list of all keys.

getBaseStore

public PartitionableObjectStore<T> getBaseStore()

getPartitionName

public String getPartitionName()