org.apache.flink.runtime.state.v2

Class InternalMapState<K,UK,V>

java.lang.Object

org.apache.flink.runtime.state.v2.InternalKeyedState<K,V>

org.apache.flink.runtime.state.v2.InternalMapState<K,UK,V>

Type Parameters:

K - The type of partitioned key the state is associated to.

UK - The type of user key of this state.

V - The type of values kept internally in state.

All Implemented Interfaces:

MapState<UK,V>, State

public class InternalMapState<K,UK,V>
extends InternalKeyedState<K,V>
implements MapState<UK,V>

A default implementation of MapState which delegates all async requests to StateRequestHandler.

Constructor Summary

Constructors

Constructor and Description
InternalMapState(StateRequestHandler stateRequestHandler, MapStateDescriptor<UK,V> stateDescriptor)

Method Summary

Modifier and Type	Method and Description
StateFuture<Boolean>	asyncContains(UK key) Returns whether there exists the given mapping asynchronously.
StateFuture<StateIterator<Map.Entry<UK,V>>>	asyncEntries() Returns the current iterator for all the mappings of this state asynchronously.
StateFuture<V>	asyncGet(UK key) Returns the current value associated with the given key asynchronously.
StateFuture<Boolean>	asyncIsEmpty() Returns whether this state contains no key-value mappings asynchronously.
StateFuture<StateIterator<UK>>	asyncKeys() Returns the current iterator for all the keys of this state asynchronously.
StateFuture<Void>	asyncPut(UK key, V value) Update the current value associated with the given key asynchronously.
StateFuture<Void>	asyncPutAll(Map<UK,V> map) Update all of the mappings from the given map into the state asynchronously.
StateFuture<Void>	asyncRemove(UK key) Delete the mapping of the given key from the state asynchronously.
StateFuture<StateIterator<V>>	asyncValues() Returns the current iterator for all the values of this state asynchronously.

Methods inherited from class org.apache.flink.runtime.state.v2.InternalKeyedState

asyncClear, getStateDescriptor, getValueSerializer, handleRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.api.common.state.v2.State

asyncClear

Constructor Detail

InternalMapState

public InternalMapState(StateRequestHandler stateRequestHandler,
                        MapStateDescriptor<UK,V> stateDescriptor)

Method Detail

asyncGet

public StateFuture<V> asyncGet(UK key)

Description copied from interface: MapState

Returns the current value associated with the given key asynchronously. When the state is not partitioned the returned value is the same for all inputs in a given operator instance. If state partitioning is applied, the value returned depends on the current operator input, as the operator maintains an independent state for each partition.

Specified by:

asyncGet in interface MapState<UK,V>

Returns:

The StateFuture that will return value corresponding to the current input. When no corresponding value for this key, the future will return null.

asyncPut

public StateFuture<Void> asyncPut(UK key,
                                  V value)

Description copied from interface: MapState

Update the current value associated with the given key asynchronously. When the state is not partitioned the value is updated for all inputs in a given operator instance. If state partitioning is applied, the updated value depends on the current operator input, as the operator maintains an independent state for each partition. When a null value is provided, the state for the given key will be removed.

Specified by:

asyncPut in interface MapState<UK,V>

Parameters:

key - The key that will be updated.

value - The new value for the key.

Returns:

The StateFuture that will trigger the callback when update finishes.

asyncPutAll

public StateFuture<Void> asyncPutAll(Map<UK,V> map)

Description copied from interface: MapState

Update all of the mappings from the given map into the state asynchronously. When the state is not partitioned the value is updated for all inputs in a given operator instance. If state partitioning is applied, the updated mapping depends on the current operator input, as the operator maintains an independent state for each partition. When a null value is provided within the map, the state for the corresponding key will be removed.

If an empty map is passed in, the state value remains unchanged.

Null map pointer is not allowed.

Specified by:

asyncPutAll in interface MapState<UK,V>

Parameters:

map - The mappings to be stored in this state.

Returns:

The StateFuture that will trigger the callback when update finishes.

asyncRemove

public StateFuture<Void> asyncRemove(UK key)

Description copied from interface: MapState

Delete the mapping of the given key from the state asynchronously. When the state is not partitioned the deleted value is the same for all inputs in a given operator instance. If state partitioning is applied, the value deleted depends on the current operator input, as the operator maintains an independent state for each partition.

Specified by:

asyncRemove in interface MapState<UK,V>

Parameters:

key - The key of the mapping.

Returns:

The StateFuture that will trigger the callback when update finishes.

asyncContains

public StateFuture<Boolean> asyncContains(UK key)

Description copied from interface: MapState

Returns whether there exists the given mapping asynchronously. When the state is not partitioned the returned value is the same for all inputs in a given operator instance. If state partitioning is applied, the value returned depends on the current operator input, as the operator maintains an independent state for each partition.

Specified by:

asyncContains in interface MapState<UK,V>

Parameters:

key - The key of the mapping.

Returns:

The StateFuture that will return true if there exists a mapping whose key equals to the given key.

asyncEntries

public StateFuture<StateIterator<Map.Entry<UK,V>>> asyncEntries()

Description copied from interface: MapState

Returns the current iterator for all the mappings of this state asynchronously. When the state is not partitioned the returned iterator is the same for all inputs in a given operator instance. If state partitioning is applied, the iterator returned depends on the current operator input, as the operator maintains an independent state for each partition.

Specified by:

asyncEntries in interface MapState<UK,V>

Returns:

The StateFuture that will return mapping iterator corresponding to the current input.

asyncKeys

public StateFuture<StateIterator<UK>> asyncKeys()

Description copied from interface: MapState

Returns the current iterator for all the keys of this state asynchronously. When the state is not partitioned the returned iterator is the same for all inputs in a given operator instance. If state partitioning is applied, the iterator returned depends on the current operator input, as the operator maintains an independent state for each partition.

Specified by:

asyncKeys in interface MapState<UK,V>

Returns:

The StateFuture that will return key iterator corresponding to the current input.

asyncValues

public StateFuture<StateIterator<V>> asyncValues()

Description copied from interface: MapState

Returns the current iterator for all the values of this state asynchronously. When the state is not partitioned the returned iterator is the same for all inputs in a given operator instance. If state partitioning is applied, the iterator returned depends on the current operator input, as the operator maintains an independent state for each partition.

Specified by:

asyncValues in interface MapState<UK,V>

Returns:

The StateFuture that will return value iterator corresponding to the current input.

asyncIsEmpty

public StateFuture<Boolean> asyncIsEmpty()

Description copied from interface: MapState

Returns whether this state contains no key-value mappings asynchronously. When the state is not partitioned the returned value is the same for all inputs in a given operator instance. If state partitioning is applied, the value returned depends on the current operator input, as the operator maintains an independent state for each partition.

Specified by:

asyncIsEmpty in interface MapState<UK,V>

Returns:

The StateFuture that will return true if there is no key-value mapping, otherwise false.