org.apache.flink.runtime.state.filesystem

Class AbstractFileStateHandle

java.lang.Object

org.apache.flink.runtime.state.AbstractCloseableHandle

org.apache.flink.runtime.state.filesystem.AbstractFileStateHandle

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, StateObject

Direct Known Subclasses:

AbstractFsStateSnapshot, FileSerializableStateHandle, FileStreamStateHandle

public abstract class AbstractFileStateHandle
extends AbstractCloseableHandle
implements StateObject

Base class for state that is stored in a file.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFileStateHandle(org.apache.flink.core.fs.Path filePath) Creates a new file state for the given file path.

Method Summary

Modifier and Type	Method and Description
void	discardState() Discard the state by deleting the file that stores the state.
org.apache.flink.core.fs.Path	getFilePath() Gets the path where this handle's state is stored.
protected long	getFileSize() Returns the file size in bytes.
protected org.apache.flink.core.fs.FileSystem	getFileSystem() Gets the file system that stores the file state.

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 org.apache.flink.runtime.state.StateObject

getStateSize

Methods inherited from interface java.io.Closeable

close

Constructor Detail

AbstractFileStateHandle

protected AbstractFileStateHandle(org.apache.flink.core.fs.Path filePath)

Creates a new file state for the given file path.

Parameters:

filePath - The path to the file that stores the state.

Method Detail

getFilePath

public org.apache.flink.core.fs.Path getFilePath()

Gets the path where this handle's state is stored.

Returns:

The path where this handle's state is stored.

discardState

public void discardState()
                  throws Exception

Discard the state by deleting the file that stores the state. If the parent directory of the state is empty after deleting the state file, it is also deleted.

Specified by:

discardState in interface StateObject

Throws:

Exception - Thrown, if the file deletion (not the directory deletion) fails.

getFileSystem

protected org.apache.flink.core.fs.FileSystem getFileSystem()
                                                     throws IOException

Gets the file system that stores the file state.

Returns:

The file system that stores the file state.

Throws:

IOException - Thrown if the file system cannot be accessed.

getFileSize

protected long getFileSize()
                    throws IOException

Returns the file size in bytes.

Returns:

The file size in bytes.

Throws:

IOException - Thrown if the file system cannot be accessed.