ninja.ugly.prevail.event.factory

Interface DeleteEventFactory<K>

Type Parameters:

K - The type of key to delete.

All Superinterfaces:

EventFactory<K,java.lang.Object>

All Known Implementing Classes:

DeleteEndEventFactory, DeleteEventFactory.EmptyDeleteEventFactory

public interface DeleteEventFactory<K>
extends EventFactory<K,java.lang.Object>

An EventFactory for delete operations on Chunks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DeleteEventFactory.EmptyDeleteEventFactory<K> An empty implementation of the DeleteEventFactory interface.

Method Summary

Methods

Modifier and Type	Method and Description
<E extends Event> com.google.common.base.Optional<E>	endEvent(K key, int numValuesDeleted) Generate an end event for deleting the given Key.
<E extends Event> com.google.common.base.Optional<E>	exceptionEvent(K key, DeleteException exception) Generate an exception event for deleting the given Key.
<E extends Event> com.google.common.base.Optional<E>	progressEvent(K key, double progress) Generate a progress event for deleting the given Key.
<E extends Event> com.google.common.base.Optional<E>	startEvent(K key) Generate a start event for deleting the given key.

Method Detail

startEvent

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

Generate a start event for deleting the given key.

Type Parameters:

E - the type of event

Parameters:

key - the key being deleted

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 deleting the given Key.

Type Parameters:

E - the type of event.

Parameters:

key - the key being deleted.

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,
                                                            int numValuesDeleted)

Generate an end event for deleting the given Key.

Type Parameters:

E - the type of event.

Parameters:

key - the key being deleted.

numValuesDeleted - the number of values deleted in the chunk operation.

Returns:

an Optional containing the generated event. Not null.

exceptionEvent

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

Generate an exception event for deleting the given Key.

Type Parameters:

E - the type of event.

Parameters:

key - the key being deleted.

exception - the DeleteException raised while deleting the value from a Chunk.

Returns:

an Optional containing the generated event. Not null.