com.asakusafw.yaess.core

Class JobMonitor

java.lang.Object

com.asakusafw.yaess.core.JobMonitor

All Implemented Interfaces:

ExecutionMonitor, Closeable, AutoCloseable

public class JobMonitor
extends Object
implements ExecutionMonitor

Receives job's progress.

Since:

0.2.3

Field Summary

Fields inherited from interface com.asakusafw.yaess.core.ExecutionMonitor

NULL

Constructor Summary

Constructors

Constructor and Description
JobMonitor(PhaseMonitor parent, String jobId, double taskSizeInParent) Creates a new instance.

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 size) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobMonitor

public JobMonitor(PhaseMonitor parent,
                  String jobId,
                  double taskSizeInParent)

Creates a new instance.

Parameters:

parent - the parent monitor

jobId - target job ID

taskSizeInParent - total task size in the parent for this monitor

Throws:

IllegalArgumentException - if parent is null

Method Detail

checkCancelled

public void checkCancelled()
                    throws InterruptedException

Description copied from interface: ExecutionMonitor

Raise InterruptedException if cancel has been requested.

Specified by:

checkCancelled in interface ExecutionMonitor

Throws:

InterruptedException - if cencel requested

open

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

Specified by:

open in interface ExecutionMonitor

Parameters:

taskSize - the total task size

Throws:

IOException - if failed to notify this event

IllegalArgumentException - if some parameters were null

progressed

public void progressed(double size)
                throws IOException

Description copied from interface: ExecutionMonitor

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

Specified by:

progressed in interface ExecutionMonitor

Parameters:

size - the difference of progressed task size

Throws:

IOException - if failed to notify this event

setProgress

public void setProgress(double workedSize)
                 throws IOException

Description copied from interface: ExecutionMonitor

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

Specified by:

setProgress in interface ExecutionMonitor

Parameters:

workedSize - the absolute progressed task size

Throws:

IOException - if failed to notify this event

getOutput

public OutputStream getOutput()
                       throws IOException

Description copied from interface: ExecutionMonitor

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.

Specified by:

getOutput in interface ExecutionMonitor

Returns:

current output stream

Throws:

IOException - if failed to prepare the output

close

public void close()
           throws IOException

Description copied from interface: ExecutionMonitor

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

Specified by:

close in interface ExecutionMonitor

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if failed to notify this event