ninja.ugly.prevail.event.factory

Class QueryEventFactory.EmptyQueryEventFactory<K,V>

java.lang.Object

ninja.ugly.prevail.event.factory.QueryEventFactory.EmptyQueryEventFactory<K,V>

Type Parameters:

K - The type of key to query.

V - The type of value to in the results.

All Implemented Interfaces:

EventFactory<K,V>, QueryEventFactory<K,V>

Direct Known Subclasses:

QueryEndEventFactory

Enclosing interface:

QueryEventFactory<K,V>

public static class QueryEventFactory.EmptyQueryEventFactory<K,V>
extends java.lang.Object
implements QueryEventFactory<K,V>

An empty implementation of the QueryEventFactory interface. Useful for extending in order to override the required factory methods.

Nested Class Summary

Nested classes/interfaces inherited from interface ninja.ugly.prevail.event.factory.QueryEventFactory

QueryEventFactory.EmptyQueryEventFactory<K,V>

Constructor Summary

Constructors

Constructor and Description
QueryEventFactory.EmptyQueryEventFactory()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryEventFactory.EmptyQueryEventFactory

public QueryEventFactory.EmptyQueryEventFactory()

Method Detail

startEvent

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

Description copied from interface: QueryEventFactory

Generate a start event for querying the given key.

Specified by:

startEvent in interface QueryEventFactory<K,V>

Type Parameters:

E - the type of event.

Parameters:

key - the key being queried.

Returns:

an Optional containing the generated event. Not null.

progressEvent

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

Description copied from interface: QueryEventFactory

Generate a progress event for querying the given key.

Specified by:

progressEvent in interface QueryEventFactory<K,V>

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

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

Description copied from interface: QueryEventFactory

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

Specified by:

endEvent in interface QueryEventFactory<K,V>

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

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

Description copied from interface: QueryEventFactory

Generate an exception event for querying the given key.

Specified by:

exceptionEvent in interface QueryEventFactory<K,V>

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.