Package org.apache.flink.runtime.state.internal

This package holds the classes of the internal state type hierarchy.

The internal state classes give access to the namespace getters and setters and access to additional functionality, like raw value access or state merging.

The public API state hierarchy is intended to be programmed against by Flink applications. The internal state hierarchy holds all the auxiliary methods that are used by the runtime and not intended to be used by user applications. These internal methods are considered of limited use to users and only confusing, and are usually not regarded as stable across releases.

Each specific type in the internal state hierarchy extends the type from the public state hierarchy. The following illustrates the relationship between the public- and the internal hierarchy at the example of a subset of the classes:

             State
               |
               +-------------------InternalKvState
               |                         |
          MergingState                   |
               |                         |
               +-----------------InternalMergingState
               |                         |
      +--------+------+                  |
      |               |                  |
 ReducingState    ListState        +-----+-----------------+
      |               |            |                       |
      |               +-----------   -----------------InternalListState
      |                            |
      +------------------InternalReducingState
 

Interface Summary

Interface	Description
InternalAggregatingState<K,N,IN,SV,OUT>	The peer to the AggregatingState in the internal state type hierarchy.
InternalAppendingState<K,N,IN,SV,OUT>	The peer to the AppendingState in the internal state type hierarchy.
InternalKvState<K,N,V>	The InternalKvState is the root of the internal state type hierarchy, similar to the State being the root of the public API state hierarchy.
InternalKvState.StateIncrementalVisitor<K,N,V>	The state entry visitor which supports remove and update of the last returned entries.
InternalListState<K,N,T>	The peer to the ListState in the internal state type hierarchy.
InternalMapState<K,N,UK,UV>	The peer to the MapState in the internal state type hierarchy.
InternalMergingState<K,N,IN,SV,OUT>	The peer to the MergingState in the internal state type hierarchy.
InternalReducingState<K,N,T>	The peer to the ReducingState in the internal state type hierarchy.
InternalValueState<K,N,T>	The peer to the ValueState in the internal state type hierarchy.