Package org.jgrapes.util.events

Class KeyValueStoreUpdate

java.lang.Object

org.jgrapes.core.internal.EventBase<Void>

org.jgrapes.core.Event<Void>

org.jgrapes.util.events.KeyValueStoreUpdate

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public class KeyValueStoreUpdate
extends Event<Void>

An event that triggers updates or deletions in a key/value store.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeyValueStoreUpdate.Action	The base class for all actions.
static class	KeyValueStoreUpdate.Deletion	A key (and value) deletion.
static class	KeyValueStoreUpdate.Update	A value update.

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Constructor	Description
KeyValueStoreUpdate()

Method Summary

Modifier and Type	Method	Description
List<KeyValueStoreUpdate.Action>	actions()	Returns the actions.
KeyValueStoreUpdate	clearAll(String... segments)	Adds a new deletion action that clears all keys with the given path prefix.
KeyValueStoreUpdate	delete(String key)	Adds a new deletion action to the event.
KeyValueStoreUpdate	storeAs(String value, String... segments)	Adds a new update action to the event that stores the given value on the path formed by the path segments.
KeyValueStoreUpdate	update(String key, String value)	Adds a new update action to the event.

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handled, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo, toString

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated, associatedGet

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Constructor Details

KeyValueStoreUpdate

public KeyValueStoreUpdate()

Method Details

update

public KeyValueStoreUpdate update(String key,
 String value)

Adds a new update action to the event.

Parameters:

key - the key

value - the value

Returns:

the event for easy chaining

storeAs

public KeyValueStoreUpdate storeAs(String value,
 String... segments)

Adds a new update action to the event that stores the given value on the path formed by the path segments.

Parameters:

value - the value

segments - the path segments

Returns:

the event for easy chaining

delete

public KeyValueStoreUpdate delete(String key)

Adds a new deletion action to the event.

Parameters:

key - the key

Returns:

the event for easy chaining

clearAll

public KeyValueStoreUpdate clearAll(String... segments)

Adds a new deletion action that clears all keys with the given path prefix.

Parameters:

segments - the path segments

Returns:

the event for easy chaining

actions

public List<KeyValueStoreUpdate.Action> actions()

Returns the actions.

Returns:

the actions