org.apache.flink.api.common.state

Class ListStateDescriptor<T>

java.lang.Object

org.apache.flink.api.common.state.StateDescriptor<ListState<T>,T>

org.apache.flink.api.common.state.ListStateDescriptor<T>

Type Parameters:

T - The type of the values that can be added to the list state.

All Implemented Interfaces:

Serializable

@PublicEvolving
public class ListStateDescriptor<T>
extends StateDescriptor<ListState<T>,T>

A StateDescriptor for ListState. This can be used to create a partitioned list state using RuntimeContext.getListState(ListStateDescriptor).

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.api.common.state.StateDescriptor

defaultValue, name, serializer

Constructor Summary

Constructors

Constructor and Description
ListStateDescriptor(String name, Class<T> typeClass) Creates a new ListStateDescriptor with the given name and list element type.
ListStateDescriptor(String name, TypeInformation<T> typeInfo) Creates a new ListStateDescriptor with the given name and list element type.
ListStateDescriptor(String name, TypeSerializer<T> typeSerializer) Creates a new ListStateDescriptor with the given name and list element type.

Method Summary

Modifier and Type	Method and Description
ListState<T>	bind(StateBackend stateBackend) Creates a new State on the given StateBackend.
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class org.apache.flink.api.common.state.StateDescriptor

getDefaultValue, getName, getSerializer, initializeSerializerUnlessSet, isSerializerInitialized

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListStateDescriptor

public ListStateDescriptor(String name,
                           Class<T> typeClass)

Creates a new ListStateDescriptor with the given name and list element type.

If this constructor fails (because it is not possible to describe the type via a class), consider using the ListStateDescriptor(String, TypeInformation) constructor.

Parameters:

name - The (unique) name for the state.

typeClass - The type of the values in the state.

ListStateDescriptor

public ListStateDescriptor(String name,
                           TypeInformation<T> typeInfo)

Creates a new ListStateDescriptor with the given name and list element type.

Parameters:

name - The (unique) name for the state.

typeInfo - The type of the values in the state.

ListStateDescriptor

public ListStateDescriptor(String name,
                           TypeSerializer<T> typeSerializer)

Creates a new ListStateDescriptor with the given name and list element type.

Parameters:

name - The (unique) name for the state.

typeSerializer - The type serializer for the list values.

Method Detail

bind

public ListState<T> bind(StateBackend stateBackend)
                  throws Exception

Description copied from class: StateDescriptor

Creates a new State on the given StateBackend.

Specified by:

bind in class StateDescriptor<ListState<T>,T>

Parameters:

stateBackend - The StateBackend on which to create the State.

Throws:

Exception

equals

public boolean equals(Object o)

Specified by:

equals in class StateDescriptor<ListState<T>,T>

hashCode

public int hashCode()

Specified by:

hashCode in class StateDescriptor<ListState<T>,T>

toString

public String toString()

Overrides:

toString in class StateDescriptor<ListState<T>,T>