Package org.apache.flink.queryablestate.client.state

Class ImmutableListState<V>

java.lang.Object

org.apache.flink.queryablestate.client.state.ImmutableListState<V>

All Implemented Interfaces:

AppendingState<V,Iterable<V>>, ListState<V>, MergingState<V,Iterable<V>>, State

public final class ImmutableListState<V>
extends Object
implements ListState<V>

A read-only ListState that does not allow for modifications.

This is the result returned when querying Flink's keyed state using the Queryable State Client and providing an ListStateDescriptor.

Field Summary

Fields

Modifier and Type	Field	Description
protected static UnsupportedOperationException	MODIFICATION_ATTEMPT_ERROR

Method Summary

Modifier and Type	Method	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.
void	clear()	Removes the value mapped under the current key.
static <V,T,S extends State> S	createState(StateDescriptor<S,T> stateDescriptor, byte[] serializedState)
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 java.lang.Object

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

Field Detail

MODIFICATION_ATTEMPT_ERROR

protected static final UnsupportedOperationException MODIFICATION_ATTEMPT_ERROR

Method Detail

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,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). TODO: An unified behaviour across all sub-classes.

Specified by:

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

Parameters:

value - The new value for the state.

clear

public void clear()

Description copied from interface: State

Removes the value mapped under the current key.

Specified by:

clear in interface 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.

createState

public static <V,T,S extends State> S createState(StateDescriptor<S,T> stateDescriptor,
                                                              byte[] serializedState)
                                                       throws IOException

Throws:

IOException