ninja.ugly.prevail.event.factory

Class UpdateEventFactory.EmptyUpdateEventFactory<K,V>

java.lang.Object

ninja.ugly.prevail.event.factory.UpdateEventFactory.EmptyUpdateEventFactory<K,V>

Type Parameters:

K - The type of key to update.

V - The type of value to update.

All Implemented Interfaces:

EventFactory<K,V>, UpdateEventFactory<K,V>

Direct Known Subclasses:

UpdateEndEventFactory

Enclosing interface:

UpdateEventFactory<K,V>

public static class UpdateEventFactory.EmptyUpdateEventFactory<K,V>
extends java.lang.Object
implements UpdateEventFactory<K,V>

An empty implementation of the UpdateEventFactory 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.UpdateEventFactory

UpdateEventFactory.EmptyUpdateEventFactory<K,V>

Constructor Summary

Constructors

Constructor and Description
UpdateEventFactory.EmptyUpdateEventFactory()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateEventFactory.EmptyUpdateEventFactory

public UpdateEventFactory.EmptyUpdateEventFactory()

Method Detail

startEvent

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

Description copied from interface: UpdateEventFactory

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

Specified by:

startEvent in interface UpdateEventFactory<K,V>

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

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

Description copied from interface: UpdateEventFactory

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

Specified by:

progressEvent in interface UpdateEventFactory<K,V>

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

public <E extends Event> com.google.common.base.Optional<E> endEvent(K key,
                                                            V value,
                                                            int numValuesUpdated)

Description copied from interface: UpdateEventFactory

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

Specified by:

endEvent in interface UpdateEventFactory<K,V>

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

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

Description copied from interface: UpdateEventFactory

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

Specified by:

exceptionEvent in interface UpdateEventFactory<K,V>

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.