org.seasar.uruma.jobs
インタフェース ProgressMonitor

既知の実装クラスの一覧:

RcpProgressMonitor

public interface ProgressMonitor

ジョブの進捗を通知するためのインタフェースです。

作成者:

y-komori

フィールドの概要

static int

UNKNOWN ジョブの総量が不明であることを示す定数です。

メソッドの概要

void	beginTask(String name, int totalWork) メインタスクの開始を通知します。
void	done() メインタスクの終了を通知します。
boolean	isCanceled() タスクがキャンセルされたかどうかを返します。
void	setCanceled(boolean value) キャンセル状態を設定します。
void	setTaskName(String name) タスク名称を設定します。
void	subTask(String name) サブタスクの開始を通知します。
void	worked(int work) 指定された値を、タスクの完了値として通知します。

フィールドの詳細

UNKNOWN

static final int UNKNOWN

ジョブの総量が不明であることを示す定数です。

関連項目:

定数フィールド値

メソッドの詳細

beginTask

void beginTask(String name,
               int totalWork)

メインタスクの開始を通知します。

パラメータ:

name - メインタスクの名称

totalWork - メインタスクの総量。値が UNKNOWN の場合、総量が不明であることを示します。

done

void done()

メインタスクの終了を通知します。

isCanceled

boolean isCanceled()

タスクがキャンセルされたかどうかを返します。

戻り値:

タスクがキャンセルされた場合、true。そうでない場合は false。

関連項目:

setCanceled(boolean)

setCanceled

void setCanceled(boolean value)

キャンセル状態を設定します。

パラメータ:

value - キャンセルが要求されている場合、true。そうでない場合、 false。

関連項目:

isCanceled()

setTaskName

void setTaskName(String name)

タスク名称を設定します。

パラメータ:

name - タスク名称

関連項目:

beginTask(java.lang.String, int)

subTask

void subTask(String name)

サブタスクの開始を通知します。
サブタスクの利用はオプションですので、必ずしも利用する必要はありません。

パラメータ:

name - サブタスクの名称

worked

void worked(int work)

指定された値を、タスクの完了値として通知します。

パラメータ:

work - 完了したタスク量。(負でない整数)