org.apache.flink.runtime.state.filesystem

Class AbstractFileState

java.lang.Object

org.apache.flink.runtime.state.filesystem.AbstractFileState

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FileSerializableStateHandle, FileStreamStateHandle, FsHeapKvStateSnapshot

public abstract class AbstractFileState
extends Object
implements Serializable

Base class for state that is stored in a file.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFileState(Path filePath) Creates a new file state for the given file path.

Method Summary

Methods

Modifier and Type	Method and Description
void	discardState() Discard the state by deleting the file that stores the state.
Path	getFilePath() Gets the path where this handle's state is stored.
protected FileSystem	getFileSystem() Gets the file system that stores the file state.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFileState

protected AbstractFileState(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 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.

Throws:

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

getFileSystem

protected 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.