ninja.ugly.prevail.chunk

Class VolatileChunk<K,V>

java.lang.Object

ninja.ugly.prevail.chunk.DefaultChunk<K,V>

ninja.ugly.prevail.chunk.VolatileChunk<K,V>

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Chunk<K,V>

public class VolatileChunk<K,V>
extends DefaultChunk<K,V>

A simple extension of DefaultChunk that stores data in memory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VolatileChunk.KeyFactory<K,V> A factory class for producing keys from values.

Nested classes/interfaces inherited from class ninja.ugly.prevail.chunk.DefaultChunk

DefaultChunk.OnProgressUpdateListener

Nested classes/interfaces inherited from interface ninja.ugly.prevail.chunk.Chunk

Chunk.EmptyChunk<K,V>

Constructor Summary

Constructors

Constructor and Description
VolatileChunk(java.util.Map<K,V> map, VolatileChunk.KeyFactory<K,V> keyFactory) Constructs a new HashMapChunk that uses the given backing Map and the given KeyFactory to generate keys during insertion.
VolatileChunk(VolatileChunk.KeyFactory<K,V> keyFactory) Constructs a new HashMapChunk that uses the given KeyFactory to generate keys during insertion.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected int	doDelete(K key, DefaultChunk.OnProgressUpdateListener onProgressUpdateListener) Delete the given key from the backing storage.
protected K	doInsert(V value, DefaultChunk.OnProgressUpdateListener onProgressUpdateListener) Insert the given value into the backing storage.
protected QueryResult<V>	doQuery(K key, DefaultChunk.OnProgressUpdateListener onProgressUpdateListener) Query the given key from the backing storage.
protected int	doUpdate(K key, V value, DefaultChunk.OnProgressUpdateListener progressUpdateListener) Update the given key in backing storage with the given value.
protected java.util.Collection<V>	getValues() Returns an unmodifiable collection of values from the backing map.
java.lang.String	toString()

Methods inherited from class ninja.ugly.prevail.chunk.DefaultChunk

addEventFactory, addEventFactory, addEventFactory, addEventFactory, delete, insert, query, setEventDispatcher, update

Methods inherited from class java.lang.Object

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

Constructor Detail

VolatileChunk

public VolatileChunk(VolatileChunk.KeyFactory<K,V> keyFactory)

Constructs a new HashMapChunk that uses the given KeyFactory to generate keys during insertion.

Parameters:

keyFactory - A KeyFactory used to create keys to insert objects under.

VolatileChunk

public VolatileChunk(java.util.Map<K,V> map,
             VolatileChunk.KeyFactory<K,V> keyFactory)

Constructs a new HashMapChunk that uses the given backing Map and the given KeyFactory to generate keys during insertion.

This implementation uses the given Map directly for storage. Changes to this Chunk will be reflected in the given Map, and vice-versa.

Parameters:

map - The Map to use as backing storage.

keyFactory - A KeyFactory used to create keys to insert objects under.

Method Detail

doInsert

protected K doInsert(V value,
         DefaultChunk.OnProgressUpdateListener onProgressUpdateListener)
              throws InsertException

Insert the given value into the backing storage.

Specified by:

doInsert in class DefaultChunk<K,V>

Parameters:

value - The value to be stored

Returns:

The key at which the given value can be obtained.

Throws:

InsertException

doQuery

protected QueryResult<V> doQuery(K key,
                     DefaultChunk.OnProgressUpdateListener onProgressUpdateListener)
                          throws QueryException

Query the given key from the backing storage.

Specified by:

doQuery in class DefaultChunk<K,V>

Parameters:

key - The key to obtain the required values

Returns:

The results

Throws:

QueryException

doUpdate

protected int doUpdate(K key,
           V value,
           DefaultChunk.OnProgressUpdateListener progressUpdateListener)
                throws UpdateException

Update the given key in backing storage with the given value.

Some Chunk implementations might allow update of multiple values with a non-specific key. Not this one.

Specified by:

doUpdate in class DefaultChunk<K,V>

Parameters:

key - The key of the value to be updated.

value - The value to be stored.

Returns:

The number of elements updated. Either 0 or 1.

Throws:

UpdateException

doDelete

protected int doDelete(K key,
           DefaultChunk.OnProgressUpdateListener onProgressUpdateListener)
                throws DeleteException

Delete the given key from the backing storage.

Some Chunk implementations might allow update of multiple values with a non-specific key. Not this one.

Specified by:

doDelete in class DefaultChunk<K,V>

Parameters:

key - The key of the value to be deleted.

Returns:

The number of values deleted. Either 0 or 1.

Throws:

DeleteException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getValues

protected java.util.Collection<V> getValues()

Returns an unmodifiable collection of values from the backing map.

Returns:

All the values in the backing map.

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException