org.apache.flink.api.common.state

Interface FoldingState<T,ACC>

Type Parameters:

T - Type of the values folded into the state

ACC - Type of the value in the state

All Superinterfaces:

AppendingState<T,ACC>, State

All Known Subinterfaces:

InternalFoldingState<K,N,T,ACC>

All Known Implementing Classes:

HeapFoldingState, ImmutableFoldingState, RocksDBFoldingState

Deprecated.

will be removed in a future version in favor of AggregatingState

@PublicEvolving
 @Deprecated
public interface FoldingState<T,ACC>
extends AppendingState<T,ACC>

State interface for folding state. Elements can be added to the state, they will be successively added to the initial value using a FoldFunction. The current state can be inspected.

The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots.

The state is only accessible by functions applied on a KeyedStream. The key is automatically supplied by the system, so the function always sees the value mapped to the key of the current element. That way, the system can handle stream and state partitioning consistently together.

Method Summary

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

add, get

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

clear