ninja.ugly.prevail.event.factory

Interface QueryEventFactory<K,V>

Type Parameters:

K - The type of key to query.

V - The type of value to in the results.

All Superinterfaces:

EventFactory<K,V>

All Known Implementing Classes:

QueryEndEventFactory, QueryEventFactory.EmptyQueryEventFactory

public interface QueryEventFactory<K,V>
extends EventFactory<K,V>

An EventFactory for query operations on Chunks.

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
<E extends Event> com.google.common.base.Optional<E>	endEvent(K key, QueryResult<V> values) Generate an end event for querying the given key with the given QueryResult.
<E extends Event> com.google.common.base.Optional<E>	exceptionEvent(K key, QueryException exception) Generate an exception event for querying the given key.
<E extends Event> com.google.common.base.Optional<E>	progressEvent(K key, double progress) Generate a progress event for querying the given key.
<E extends Event> com.google.common.base.Optional<E>	startEvent(K key) Generate a start event for querying the given key.

Method Detail

startEvent

<E extends Event> com.google.common.base.Optional<E> startEvent(K key)

Generate a start event for querying the given key.

Type Parameters:

E - the type of event.

Parameters:

key - the key being queried.

Returns:

an Optional containing the generated event. Not null.

progressEvent

<E extends Event> com.google.common.base.Optional<E> progressEvent(K key,
                                                                 double progress)

Generate a progress event for querying the given key.

Type Parameters:

E - the type of event.

Parameters:

key - the key being queried.

progress - a representation of the progress of the delete operation.

Returns:

an Optional containing the generated event. Not null.

endEvent

<E extends Event> com.google.common.base.Optional<E> endEvent(K key,
                                                            QueryResult<V> values)

Generate an end event for querying the given key with the given QueryResult.

Type Parameters:

E - the type of event.

Parameters:

key - the key being queried.

values - the QueryResult of the query operation.

Returns:

an Optional containing the generated event. Not null.

exceptionEvent

<E extends Event> com.google.common.base.Optional<E> exceptionEvent(K key,
                                                                  QueryException exception)

Generate an exception event for querying the given key.

Type Parameters:

E - the type of event

Parameters:

key - the key being queried.

exception - the QueryException raised while querying the key at a Chunk.

Returns:

an Optional containing the generated event. Not null.