com.asakusafw.yaess.core

Interface ExecutionMonitor

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

FlowLogger, JobMonitor, LoggingExecutionMonitor, PhaseMonitor

public interface ExecutionMonitor
extends Closeable

Receives execution's progress.

Since:

0.2.3

Field Summary

Fields

Modifier and Type	Field and Description
static ExecutionMonitor	NULL An empty implementation.

Method Summary

Modifier and Type	Method and Description
void	checkCancelled() Raise InterruptedException if cancel has been requested.
void	close() Ends the current task and notify this event to the corresponding receiver.
OutputStream	getOutput() Returns output stream for extra information.
void	open(double taskSize) Begins a task and notify this event to the corresponding receiver.
void	progressed(double deltaSize) Progresses the current task and notify this event to the corresponding receiver.
void	setProgress(double workedSize) Sets the progress of current task and notify this event to the corresponding receiver.

Field Detail

NULL

static final ExecutionMonitor NULL

An empty implementation.

Method Detail

open

void open(double taskSize)
   throws IOException

Begins a task and notify this event to the corresponding receiver. This method can be invoked once for each object.

Parameters:

taskSize - the total task size

Throws:

IOException - if failed to notify this event

IllegalArgumentException - if some parameters were null

checkCancelled

void checkCancelled()
             throws InterruptedException

Raise InterruptedException if cancel has been requested.

Throws:

InterruptedException - if cencel requested

progressed

void progressed(double deltaSize)
         throws IOException

Progresses the current task and notify this event to the corresponding receiver.

Parameters:

deltaSize - the difference of progressed task size

Throws:

IOException - if failed to notify this event

IllegalArgumentException - if some parameters were null

setProgress

void setProgress(double workedSize)
          throws IOException

Sets the progress of current task and notify this event to the corresponding receiver.

Parameters:

workedSize - the absolute progressed task size

Throws:

IOException - if failed to notify this event

IllegalArgumentException - if some parameters were null

getOutput

OutputStream getOutput()
                throws IOException

Returns output stream for extra information. This stream must not be closed by out of the monitors, the stream will be closed automatically in the monitor.

Returns:

current output stream

Throws:

IOException - if failed to prepare the output

close

void close()
    throws IOException

Ends the current task and notify this event to the corresponding receiver.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if failed to notify this event