ninja.ugly.prevail.chunk

Interface Chunk<K,V>

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

Chunk.EmptyChunk, DefaultChunk, VolatileChunk

public interface Chunk<K,V>
extends java.io.Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Chunk.EmptyChunk<K,V> An empty implementation of the Chunk interface

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventFactory(DeleteEventFactory deleteEventFactory) Add an DeleteEventFactory to use when generating insert events.
void	addEventFactory(InsertEventFactory insertEventFactory) Add an InsertEventFactory to use when generating insert events.
void	addEventFactory(QueryEventFactory queryEventFactory) Add an QueryEventFactory to use when generating insert events.
void	addEventFactory(UpdateEventFactory updateEventFactory) Add an UpdateEventFactory to use when generating insert events.
int	delete(K key, DeleteEventFactory<K>... customEventFactory) Delete a key from this Chunk, returning the number of values deleted.
K	insert(V value, InsertEventFactory<K,V>... customEventFactory) Insert a value into this Chunk, returning the key at which the get can be retrieved later.
QueryResult<V>	query(K key, QueryEventFactory<K,V>... customEventFactory) Query a key at this Chunk, returning a QueryResult contianing the queried values.
void	setEventDispatcher(EventDispatcher eventDispatcher) Set the EventDispatcher on this Chunk.
int	update(K key, V value, UpdateEventFactory<K,V>... customEventFactory) Update a key with a value at this Chunk, returning the number of values updated.

Methods inherited from interface java.io.Closeable

close

Method Detail

insert

K insert(V value,
       InsertEventFactory<K,V>... customEventFactory)
         throws InsertException

Insert a value into this Chunk, returning the key at which the get can be retrieved later. If an EventDispatcher is set on this Chunk, then events generated by the given list of InsertEventFactories will be dispatched thereon. Additionally, events will be dispatched as generated by any InsertEventFactory previously added to the Chunk.

Parameters:

value - the value to insert

customEventFactory - optional InsertEventFactories used to generate events for this operation.

Throws:

InsertException

query

QueryResult<V> query(K key,
                   QueryEventFactory<K,V>... customEventFactory)
                     throws QueryException

Query a key at this Chunk, returning a QueryResult contianing the queried values. If an EventDispatcher is set on this Chunk, then events generated by the given list of QueryEventFactories will be dispatched thereon. Additionally, events will be dispatched as generated by any QueryEventFactory previously added to the Chunk.

Parameters:

key - the key to query

customEventFactory - optional QueryEventFactories used to generate events for this operation.

Throws:

QueryException

update

int update(K key,
         V value,
         UpdateEventFactory<K,V>... customEventFactory)
           throws UpdateException

Update a key with a value at this Chunk, returning the number of values updated. If an EventDispatcher is set on this Chunk, then events generated by the given list of QueryEventFactories will be dispatched thereon. Additionally, events will be dispatched as generated by any UpdateEventFactory previously added to the Chunk.

Parameters:

key - the key to update

value - the value to update

customEventFactory - optional UpdateEventFactories used to generate events for this operation.

Throws:

UpdateException

delete

int delete(K key,
         DeleteEventFactory<K>... customEventFactory)
           throws DeleteException

Delete a key from this Chunk, returning the number of values deleted. If an EventDispatcher is set on this Chunk, then events generated by the given list of DeleteEventFactories will be dispatched thereon. Additionally, events will be dispatched as generated by any DeleteEventFactory previously added to the Chunk.

Parameters:

key - the key to delete

customEventFactory - optional DeleteEventFactories used to generate events for this operation.

Throws:

DeleteException

setEventDispatcher

void setEventDispatcher(EventDispatcher eventDispatcher)

Set the EventDispatcher on this Chunk.

Operations on this Chunk will dispatch events to the given EventDispatcher. The events dispatched are generated by EventFactories that are either previously added to this Chunk, or else passed in as a parameter to the Chunk operation.

Parameters:

eventDispatcher - The EventDispatcher to be used for events on this Chunk.

addEventFactory

void addEventFactory(InsertEventFactory insertEventFactory)

Add an InsertEventFactory to use when generating insert events.

addEventFactory

void addEventFactory(QueryEventFactory queryEventFactory)

Add an QueryEventFactory to use when generating insert events.

addEventFactory

void addEventFactory(UpdateEventFactory updateEventFactory)

Add an UpdateEventFactory to use when generating insert events.

addEventFactory

void addEventFactory(DeleteEventFactory deleteEventFactory)

Add an DeleteEventFactory to use when generating insert events.