Package org.aksw.shellgebra.exec

Class FileWriterTaskBase

java.lang.Object

org.aksw.shellgebra.exec.FileWriterTaskBase

All Implemented Interfaces:

AutoCloseable, FileWriterTask

Direct Known Subclasses:

FileWriterTaskNoop, FileWriterTaskViaExecutor

public abstract class FileWriterTaskBase
extends Object
implements FileWriterTask

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FileWriterTaskBase.PathLifeCycle
static enum	FileWriterTaskBase.TaskState

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isAbortCalled
protected Path	outputPath	The file being generated.
protected FileWriterTaskBase.PathLifeCycle	pathLifeCycle
protected AtomicReference<FileWriterTaskBase.TaskState>	state

Constructor Summary

Constructors

Constructor	Description
FileWriterTaskBase(Path path, FileWriterTaskBase.PathLifeCycle pathLifeCycle)

Method Summary

Modifier and Type	Method	Description
abstract void	abort()
protected void	checkIfAbortHasBeenCalled()	Only call this method from within a synchronized block!
protected void	checkIfNew()
Path	getOutputPath()	The path that will be written to by this writer.
FileWriterTaskBase.TaskState	getState()
boolean	isFinished()
boolean	isStarted()
protected abstract void	onCompletion()	Called on completion - regardless whether successful or not.
protected abstract void	prepareWriteFile()	Method that allows for setting up resources in an atomic way.
protected abstract void	runWriteFile()
abstract void	waitForCompletion()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.aksw.shellgebra.exec.FileWriterTask

start

Field Details

outputPath

protected Path outputPath

The file being generated.

pathLifeCycle

protected FileWriterTaskBase.PathLifeCycle pathLifeCycle

state

protected AtomicReference<FileWriterTaskBase.TaskState> state

isAbortCalled

protected volatile boolean isAbortCalled

Constructor Details

FileWriterTaskBase

public FileWriterTaskBase(Path path,
 FileWriterTaskBase.PathLifeCycle pathLifeCycle)

Method Details

getOutputPath

public Path getOutputPath()

Description copied from interface: FileWriterTask

The path that will be written to by this writer.

Specified by:

getOutputPath in interface FileWriterTask

checkIfNew

protected void checkIfNew()

checkIfAbortHasBeenCalled

protected void checkIfAbortHasBeenCalled()

Only call this method from within a synchronized block!

isStarted

public boolean isStarted()

isFinished

public boolean isFinished()

getState

public FileWriterTaskBase.TaskState getState()

prepareWriteFile

protected abstract void prepareWriteFile()
                                  throws IOException

Method that allows for setting up resources in an atomic way. STARTING.

Throws:

IOException

runWriteFile

protected abstract void runWriteFile()
                              throws IOException

Throws:

IOException

onCompletion

protected abstract void onCompletion()
                              throws IOException

Called on completion - regardless whether successful or not. Only called if prepareWriteFile has been called before. (doWriteFile may not have been called).

Throws:

IOException

waitForCompletion

public abstract void waitForCompletion()
                                throws ExecutionException,
InterruptedException

Specified by:

waitForCompletion in interface FileWriterTask

Throws:

ExecutionException

InterruptedException

abort

public abstract void abort()

Specified by:

abort in interface FileWriterTask