ninja.ugly.prevail.event.factory

Interface UpdateEventFactory<K,V>

Type Parameters:

K - The type of key to update.

V - The type of value to update.

All Superinterfaces:

EventFactory<K,V>

All Known Implementing Classes:

UpdateEndEventFactory, UpdateEventFactory.EmptyUpdateEventFactory

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

An EventFactory for update operations on Chunks.

Nested Class Summary

Nested Classes

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

Method Summary

Methods

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

Method Detail

startEvent

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

Generate a start event for updating the given key with the given value.

Type Parameters:

E - the type of event.

Parameters:

key - the key being updated.

value - the value to update with.

Returns:

an Optional containing the generated event. Not null.

progressEvent

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

Generate a progress event for updating the given key with the given value.

Type Parameters:

E - the type of event.

Parameters:

key - the key being updated.

value - the value to update with.

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,
                                                            V value,
                                                            int numValuesUpdated)

Generate an end event for updating the given key with the given value.

Type Parameters:

E - the type of event.

Parameters:

key - the key being updated.

value - the value to update with.

numValuesUpdated - the number of values updated in the Chunk.

Returns:

an Optional containing the generated event. Not null.

exceptionEvent

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

Generate an exception event for updating the given key with the given value.

Type Parameters:

E - the type of event.

Parameters:

key - the key being updated.

value - the value to update with.

exception - the UpdateException raised while updated the key with the value at a Chunk.

Returns:

an Optional containing the generated event. Not null.