com.scaleoutsoftware.soss.client.map

Class NamedMapInvokableContext<K,V>

java.lang.Object

com.scaleoutsoftware.soss.client.map.NamedMapInvokableContext<K,V>

Type Parameters:

K - key type

V - value type

public abstract class NamedMapInvokableContext<K,V>
extends java.lang.Object

A context used by NamedMapInvokable.evalPartialKeySet(NamedMapInvokableContext, Object), to iterate through keys and perform an operation on the current key.

Constructor Summary

Constructors

Constructor and Description
NamedMapInvokableContext()

Method Summary

Modifier and Type	Method and Description
abstract K	getKey() Returns current key.
abstract NamedMap<K,V>	getMap() Returns the NamedMap this operation is performed on.
abstract V	getValue() Returns current value.
abstract boolean	next() Reads the next key and value from the map.
abstract void	removeCurrentKey() Removes the current key from the named map.
abstract void	updateCurrentValue(V newValue) Updates the value for the current key.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedMapInvokableContext

public NamedMapInvokableContext()

Method Detail

getKey

public abstract K getKey()

Returns current key.

Returns:

current key.

getValue

public abstract V getValue()

Returns current value.

Returns:

current value

next

public abstract boolean next()
                      throws InvokeException

Reads the next key and value from the map.

Returns:

true if successfully read next key and value, false otherwise

Throws:

InvokeException - when a server invocation error has occurred.

updateCurrentValue

public abstract void updateCurrentValue(V newValue)

Updates the value for the current key.

Parameters:

newValue - new value to assign for the key

removeCurrentKey

public abstract void removeCurrentKey()

Removes the current key from the named map.

getMap

public abstract NamedMap<K,V> getMap()

Returns the NamedMap this operation is performed on.

Returns:

current named map