org.apache.flink.runtime.state.memory

Class ByteStreamStateHandle

java.lang.Object

org.apache.flink.runtime.state.memory.ByteStreamStateHandle

All Implemented Interfaces:

Serializable, StateHandle<InputStream>, StreamStateHandle

public final class ByteStreamStateHandle
extends Object
implements StreamStateHandle

A state handle that contains stream state in a byte array.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ByteStreamStateHandle(byte[] data) Creates a new ByteStreamStateHandle containing the given data.

Method Summary

Modifier and Type	Method and Description
void	discardState() Discards the state referred to by this handle, to free up resources in the persistent storage.
InputStream	getState(ClassLoader userCodeClassLoader) This retrieves and return the state represented by the handle.
long	getStateSize() Returns the size of the state in bytes.
<T extends Serializable> StateHandle<T>	toSerializableHandle() Converts this stream state handle into a state handle that de-serializes the stream into an object using Java's serialization mechanism.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteStreamStateHandle

public ByteStreamStateHandle(byte[] data)

Creates a new ByteStreamStateHandle containing the given data.

Parameters:

data - The state data.

Method Detail

getState

public InputStream getState(ClassLoader userCodeClassLoader)

Description copied from interface: StateHandle

This retrieves and return the state represented by the handle.

Specified by:

getState in interface StateHandle<InputStream>

Parameters:

userCodeClassLoader - Class loader for deserializing user code specific classes

Returns:

The state represented by the handle.

discardState

public void discardState()

Description copied from interface: StateHandle

Discards the state referred to by this handle, to free up resources in the persistent storage. This method is called when the handle will not be used any more.

Specified by:

discardState in interface StateHandle<InputStream>

getStateSize

public long getStateSize()

Description copied from interface: StateHandle

Returns the size of the state in bytes.

If the the size is not known, return 0.

Specified by:

getStateSize in interface StateHandle<InputStream>

Returns:

Size of the state in bytes.

toSerializableHandle

public <T extends Serializable> StateHandle<T> toSerializableHandle()

Description copied from interface: StreamStateHandle

Converts this stream state handle into a state handle that de-serializes the stream into an object using Java's serialization mechanism.

Specified by:

toSerializableHandle in interface StreamStateHandle

Returns:

The state handle that automatically de-serializes.