Package org.jgrapes.util.events

Class KeyValueStoreQuery

java.lang.Object

org.jgrapes.core.internal.EventBase<Map<String,String>>

org.jgrapes.core.Event<Map<String,String>>

org.jgrapes.util.events.KeyValueStoreQuery

All Implemented Interfaces:

Future<Map<String,String>>, Associator, Eligible

public class KeyValueStoreQuery
extends Event<Map<String,String>>

A query event for a key/value store.

Nested Class Summary

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
KeyValueStoreQuery(String key)	Creates a new event that queries using the given key.
KeyValueStoreQuery(String key, Channel channel)	Convenience constructor for creating a new event with a completion event of type KeyValueStoreData that is fired on the given channel.

Method Summary

Modifier and Type	Method	Description
String	query()	Returns the key used for the query.

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

KeyValueStoreQuery

public KeyValueStoreQuery(String key)

Creates a new event that queries using the given key.

The result of the event is a map with the retrieved entries.

Parameters:

key - the key

KeyValueStoreQuery

public KeyValueStoreQuery(String key,
 Channel channel)

Convenience constructor for creating a new event with a completion event of type KeyValueStoreData that is fired on the given channel.

Parameters:

key - the key

channel - the channel

Method Details

query

public String query()

Returns the key used for the query.

Returns:

the key