org.apache.flink.runtime.state

Class OperatorState<T>

java.lang.Object

org.apache.flink.runtime.state.OperatorState<T>

Type Parameters:

T - The type of the operator state.

All Implemented Interfaces:

Serializable

public class OperatorState<T>
extends Object
implements Serializable

Abstract class for representing operator states in Flink programs. By implementing the methods declared in this abstraction the state of the operator can be checkpointed by the fault tolerance mechanism.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OperatorState(T initialState) Initializes the state using the given state object.

Method Summary

Modifier and Type	Method and Description
StateCheckpoint<T>	checkpoint() Creates a StateCheckpoint that will be used to backup the state for failure recovery.
T	getState() Returns the currently stored state object.
boolean	stateEquals(OperatorState<T> other)
String	toString()
void	update(Object stateUpdate) Updates the current state object.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorState

public OperatorState(T initialState)

Initializes the state using the given state object.

Parameters:

initialState - The initial state object

Method Detail

getState

public T getState()

Returns the currently stored state object.

Returns:

The state.

update

public void update(Object stateUpdate)

Updates the current state object. States should be only updated using this method to avoid concurrency issues.

Parameters:

stateUpdate - The update applied.

checkpoint

public StateCheckpoint<T> checkpoint()

Creates a StateCheckpoint that will be used to backup the state for failure recovery. This method will be called by the state checkpointer.

Returns:

The StateCheckpoint created.

toString

public String toString()

Overrides:

toString in class Object

stateEquals

public boolean stateEquals(OperatorState<T> other)