org.apache.flink.runtime.state.heap

Class HeapValueState<K,N,V>

java.lang.Object

org.apache.flink.runtime.state.heap.AbstractHeapState<K,N,V,ValueState<V>,ValueStateDescriptor<V>>

org.apache.flink.runtime.state.heap.HeapValueState<K,N,V>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

V - The type of the value.

All Implemented Interfaces:

State, ValueState<V>, InternalKvState<N>, InternalValueState<N,V>

public class HeapValueState<K,N,V>
extends AbstractHeapState<K,N,V,ValueState<V>,ValueStateDescriptor<V>>
implements InternalValueState<N,V>

Heap-backed partitioned ValueState that is snapshotted into files.

Field Summary

Fields inherited from class org.apache.flink.runtime.state.heap.AbstractHeapState

currentNamespace, keySerializer, namespaceSerializer, stateDesc, stateTable

Constructor Summary

Constructors

Constructor and Description
HeapValueState(ValueStateDescriptor<V> stateDesc, StateTable<K,N,V> stateTable, TypeSerializer<K> keySerializer, TypeSerializer<N> namespaceSerializer) Creates a new key/value state for the given hash map of key/value pairs.

Method Summary

Modifier and Type	Method and Description
void	update(V value) Updates the operator state accessible by ValueState.value() to the given value.
V	value() Returns the current value for the state.

Methods inherited from class org.apache.flink.runtime.state.heap.AbstractHeapState

clear, getSerializedValue, getSerializedValue, getStateTable, setCurrentNamespace

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.runtime.state.internal.InternalKvState

getSerializedValue, setCurrentNamespace

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

clear

Constructor Detail

HeapValueState

public HeapValueState(ValueStateDescriptor<V> stateDesc,
                      StateTable<K,N,V> stateTable,
                      TypeSerializer<K> keySerializer,
                      TypeSerializer<N> namespaceSerializer)

Creates a new key/value state for the given hash map of key/value pairs.

Parameters:

stateDesc - The state identifier for the state. This contains name and can create a default state value.

stateTable - The state tab;e to use in this kev/value state. May contain initial state.

Method Detail

value

public V value()

Description copied from interface: ValueState

Returns the current value for the state. 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.

If you didn't specify a default value when creating the ValueStateDescriptor this will return null when to value was previously set using ValueState.update(Object).

Specified by:

value in interface ValueState<V>

Returns:

The state value corresponding to the current input.

update

public void update(V value)

Description copied from interface: ValueState

Updates the operator state accessible by ValueState.value() to the given value. The next time ValueState.value() is called (for the same state partition) the returned state will represent the updated value. When a partitioned state is updated with null, the state for the current key will be removed and the default value is returned on the next access.

Specified by:

update in interface ValueState<V>

Parameters:

value - The new value for the state.