org.apache.flink.runtime.state.v2

Class InternalListState<K,N,V>

java.lang.Object

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

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

Type Parameters:

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

V - The type of values kept internally in state.

All Implemented Interfaces:

AppendingState<V,StateIterator<V>,Iterable<V>>, ListState<V>, MergingState<V,StateIterator<V>,Iterable<V>>, State, InternalPartitionedState<N>

Direct Known Subclasses:

ForStListState

public class InternalListState<K,N,V>
extends InternalKeyedState<K,N,V>
implements ListState<V>

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

Field Summary

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

stateRequestHandler

Constructor Summary

Constructors

Constructor and Description
InternalListState(StateRequestHandler stateRequestHandler, ListStateDescriptor<V> stateDescriptor)

Method Summary

Modifier and Type	Method and Description
void	add(V value) Updates the operator state accessible by AppendingState.get() by adding the given value to the list of values.
void	addAll(List<V> values) Updates the operator state accessible by AppendingState.get() by adding the given values to existing list of values.
StateFuture<Void>	asyncAdd(V value) Updates the operator state accessible by AppendingState.asyncGet() by adding the given value to the list of values asynchronously.
StateFuture<Void>	asyncAddAll(List<V> values) Updates the operator state accessible by AppendingState.asyncGet() by adding the given values to existing list of values asynchronously.
StateFuture<StateIterator<V>>	asyncGet() Returns the current value for the state asynchronously.
StateFuture<Void>	asyncUpdate(List<V> values) Updates the operator state accessible by AppendingState.asyncGet() by updating existing values to the given list of values asynchronously.
Iterable<V>	get() Returns the current value for the state.
void	update(List<V> values) Updates the operator state accessible by AppendingState.get() by updating existing values to the given list of values.

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

asyncClear, clear, getStateDescriptor, getStateRequestHandler, getValueSerializer, handleRequest, handleRequestSync, 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.api.common.state.v2.State

asyncClear, clear

Constructor Detail

InternalListState

public InternalListState(StateRequestHandler stateRequestHandler,
                         ListStateDescriptor<V> stateDescriptor)

Method Detail

asyncGet

public StateFuture<StateIterator<V>> asyncGet()

Description copied from interface: AppendingState

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

NOTE TO IMPLEMENTERS: if the state is empty, then this method should return null wrapped by a StateFuture.

Specified by:

asyncGet in interface AppendingState<V,StateIterator<V>,Iterable<V>>

Returns:

The operator state value corresponding to the current input or null wrapped by a StateFuture if the state is empty.

asyncAdd

public StateFuture<Void> asyncAdd(V value)

Description copied from interface: AppendingState

Updates the operator state accessible by AppendingState.asyncGet() by adding the given value to the list of values asynchronously. The next time AppendingState.asyncGet() is called (for the same state partition) the returned state will represent the updated list.

null value is not allowed to be passed in.

Specified by:

asyncAdd in interface AppendingState<V,StateIterator<V>,Iterable<V>>

Parameters:

value - The new value for the state.

asyncUpdate

public StateFuture<Void> asyncUpdate(List<V> values)

Description copied from interface: ListState

Updates the operator state accessible by AppendingState.asyncGet() by updating existing values to the given list of values asynchronously. The next time AppendingState.asyncGet() is called (for the same state partition) the returned state will represent the updated list.

If an empty list is passed in, the state value will be null.

Null value passed in or any null value in list is not allowed.

Specified by:

asyncUpdate in interface ListState<V>

Parameters:

values - The new values for the state.

asyncAddAll

public StateFuture<Void> asyncAddAll(List<V> values)

Description copied from interface: ListState

Updates the operator state accessible by AppendingState.asyncGet() by adding the given values to existing list of values asynchronously. The next time AppendingState.asyncGet() is called (for the same state partition) the returned state will represent the updated list.

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

Null value passed in or any null value in list is not allowed.

Specified by:

asyncAddAll in interface ListState<V>

Parameters:

values - The new values to be added to the state.

get

public Iterable<V> get()

Description copied from interface: AppendingState

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.

NOTE TO IMPLEMENTERS: if the state is empty, then this method should return null.

Specified by:

get in interface AppendingState<V,StateIterator<V>,Iterable<V>>

Returns:

The operator state value corresponding to the current input or null if the state is empty.

add

public void add(V value)

Description copied from interface: AppendingState

Updates the operator state accessible by AppendingState.get() by adding the given value to the list of values. The next time AppendingState.get() is called (for the same state partition) the returned state will represent the updated list.

If null is passed in, the behaviour is undefined (implementation related).

Specified by:

add in interface AppendingState<V,StateIterator<V>,Iterable<V>>

Parameters:

value - The new value for the state.

update

public void update(List<V> values)

Description copied from interface: ListState

Updates the operator state accessible by AppendingState.get() by updating existing values to the given list of values. The next time AppendingState.get() is called (for the same state partition) the returned state will represent the updated list.

If an empty list is passed in, the state value will be null.

Null value passed in or any null value in list is not allowed.

Specified by:

update in interface ListState<V>

Parameters:

values - The new values for the state.

addAll

public void addAll(List<V> values)

Description copied from interface: ListState

Updates the operator state accessible by AppendingState.get() by adding the given values to existing list of values. The next time AppendingState.get() is called (for the same state partition) the returned state will represent the updated list.

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

Null value passed in or any null value in list is not allowed.

Specified by:

addAll in interface ListState<V>

Parameters:

values - The new values to be added to the state.