ninja.ugly.prevail.event.factory

Interface InsertEventFactory<K,V>

Type Parameters:

V - The type of value to insert

K - The type of key generated for the inserted value.

All Superinterfaces:

EventFactory<K,V>

All Known Implementing Classes:

InsertEndEventFactory, InsertEventFactory.EmptyInsertEventFactory

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

An EventFactory for insert operations on Chunks.

Nested Class Summary

Nested Classes

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

Method Summary

Methods

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

Method Detail

startEvent

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

Generate a start event for inserting the given value.

Type Parameters:

E - the type of event

Parameters:

value - the value being inserted

Returns:

an Optional containing the generated event. Not null.

progressEvent

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

Generate a progress event for inserting the given value.

Type Parameters:

E - the type of event.

Parameters:

value - the value being inserted.

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)

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

Type Parameters:

E - the type of event

Parameters:

key - the key returned during the insert operation at which the value can be obtained later.

value - the value being inserted

Returns:

an Optional containing the generated event. Not null.

exceptionEvent

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

Generate an exception event for inserting the given value.

Type Parameters:

E - the type of event

Parameters:

value - the value being inserted

exception - the InsertException raised while inserting the value to a Chunk.

Returns:

an Optional containing the generated event. Not null.