org.apache.flink.runtime.state.memory

Class SerializedStateHandle<T extends Serializable>

java.lang.Object

org.apache.flink.runtime.state.AbstractCloseableHandle

org.apache.flink.runtime.state.memory.SerializedStateHandle<T>

Type Parameters:

T - The type of state represented by this state handle.

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, StateHandle<T>, StateObject

public class SerializedStateHandle<T extends Serializable>
extends AbstractCloseableHandle
implements StateHandle<T>

A state handle that represents its state in serialized form as bytes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SerializedStateHandle(byte[] serializedData) Creates a new serialized state handle, based in the given already serialized data.
SerializedStateHandle(T value) Creates a new serialized state handle, eagerly serializing the given state object.

Method Summary

Modifier and Type	Method and Description
void	discardState() Discarding heap-memory backed state is a no-op, so this method does nothing.
int	getSizeOfSerializedState() Gets the size of the serialized state.
T	getState(ClassLoader classLoader) This retrieves and return the state represented by the handle.
long	getStateSize() Returns the size of the state in bytes.

Methods inherited from class org.apache.flink.runtime.state.AbstractCloseableHandle

close, ensureNotClosed, isClosed, registerCloseable

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

SerializedStateHandle

public SerializedStateHandle(T value)
                      throws IOException

Creates a new serialized state handle, eagerly serializing the given state object.

Parameters:

value - The state object.

Throws:

IOException - Thrown, if the serialization fails.

SerializedStateHandle

public SerializedStateHandle(byte[] serializedData)

Creates a new serialized state handle, based in the given already serialized data.

Parameters:

serializedData - The serialized data.

Method Detail

getState

public T getState(ClassLoader classLoader)
           throws Exception

Description copied from interface: StateHandle

This retrieves and return the state represented by the handle.

Specified by:

getState in interface StateHandle<T extends Serializable>

Parameters:

classLoader - Class loader for deserializing user code specific classes

Returns:

The state represented by the handle.

Throws:

Exception - Thrown, if the state cannot be fetched.

getSizeOfSerializedState

public int getSizeOfSerializedState()

Gets the size of the serialized state.

Returns:

The size of the serialized state.

discardState

public void discardState()

Discarding heap-memory backed state is a no-op, so this method does nothing.

Specified by:

discardState in interface StateObject

getStateSize

public long getStateSize()

Description copied from interface: StateObject

Returns the size of the state in bytes.

If the the size is not known, return 0.

Specified by:

getStateSize in interface StateObject

Returns:

Size of the state in bytes.