org.ashikunep.irenka.world
クラス NullCtProgressMonitor

java.lang.Object
  org.ashikunep.irenka.world.NullCtProgressMonitor

すべての実装されたインタフェース:

ClientStorageContainer, CtProgressMonitor

public class NullCtProgressMonitor
extends Object
implements CtProgressMonitor

何も行わないCtProgressMonitorの実装。

バージョン:

$Date: 2008-02-12 12:35:47 +0900 (火, 12 2月 2008) $

作成者:

Suguru ARAKAWA (Gluegent, Inc.)

コンストラクタの概要

NullCtProgressMonitor()
インスタンスを生成する。

メソッドの概要

void	beginTask(String taskName, int taskSize) タスクを登録して、開始する。
void	cancel(IrenkaException cause) このモニタを利用しているのタスクに対してキャンセルを要求する。
void	done() タスクが完了したことを通知する。
<S extends ClientStorage> S	getClientStorage(Object key, Class<S> storageType) このオブジェクトに関連付けられた記憶クラスを返す。
boolean	isCanceled() このモニタを利用するタスクに、キャンセルを要求されている場合のみtrueを返す。
CtProgressMonitor	newPartialMonitor(int partialTaskSize) このモニタの部分モニタを生成して返す。
CtProgressMonitor	newPartialMonitor(int partialTaskSize, PartialProgressMonitorAttribute attribute) このモニタの部分モニタを生成して返す。
void	putClientStorage(Object key, ClientStorage newStorage) このオブジェクトに新しくユーザ記憶クラスを追加する。
void	subTask(String subTaskName) 以降に着手するサブタスクの名称を設定する。
String	toString() このモニタを実装するクラスの単純名を返す。
void	worked(int completedTaskSize) タスクが進捗したことを通知する。

クラス java.lang.Object から継承されたメソッド

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

コンストラクタの詳細

NullCtProgressMonitor

public NullCtProgressMonitor()

インスタンスを生成する。

メソッドの詳細

beginTask

public void beginTask(String taskName,
                      int taskSize)

インタフェース CtProgressMonitor の記述:

タスクを登録して、開始する。

定義:

インタフェース CtProgressMonitor 内の beginTask

パラメータ:

taskName - 開始するタスクの名前

taskSize - 開始するタスク全体の大きさ

done

public void done()

インタフェース CtProgressMonitor の記述:

タスクが完了したことを通知する。

定義:

インタフェース CtProgressMonitor 内の done

newPartialMonitor

public CtProgressMonitor newPartialMonitor(int partialTaskSize)

インタフェース CtProgressMonitor の記述:

このモニタの部分モニタを生成して返す。

定義:

インタフェース CtProgressMonitor 内の newPartialMonitor

パラメータ:

partialTaskSize - 生成する部分タスクが、このタスクに占めるタスクの大きさ

戻り値:

生成した開始されていない部分タスク

newPartialMonitor

public CtProgressMonitor newPartialMonitor(int partialTaskSize,
                                           PartialProgressMonitorAttribute attribute)

インタフェース CtProgressMonitor の記述:

このモニタの部分モニタを生成して返す。

定義:

インタフェース CtProgressMonitor 内の newPartialMonitor

パラメータ:

partialTaskSize - 生成する部分タスクが、このタスクに占めるタスクの大きさ

attribute - 表示方法に関する属性

戻り値:

生成した開始されていない部分タスク

subTask

public void subTask(String subTaskName)

インタフェース CtProgressMonitor の記述:

以降に着手するサブタスクの名称を設定する。

定義:

インタフェース CtProgressMonitor 内の subTask

パラメータ:

subTaskName - 以降に着手するサブタスクの名称

worked

public void worked(int completedTaskSize)

インタフェース CtProgressMonitor の記述:

タスクが進捗したことを通知する。

定義:

インタフェース CtProgressMonitor 内の worked

パラメータ:

completedTaskSize - タスク全体のうち、進捗によって消化されたタスクのサイズ

cancel

public void cancel(IrenkaException cause)

インタフェース CtProgressMonitor の記述:

このモニタを利用しているのタスクに対してキャンセルを要求する。

定義:

インタフェース CtProgressMonitor 内の cancel

パラメータ:

cause - キャンセルの理由(省略可)

isCanceled

public boolean isCanceled()

インタフェース CtProgressMonitor の記述:

このモニタを利用するタスクに、キャンセルを要求されている場合のみtrueを返す。

定義:

インタフェース CtProgressMonitor 内の isCanceled

戻り値:

キャンセルを要求されている場合のみtrue

getClientStorage

public <S extends ClientStorage> S getClientStorage(Object key,
                                                    Class<S> storageType)

インタフェース ClientStorageContainer の記述:

このオブジェクトに関連付けられた記憶クラスを返す。

定義:

インタフェース ClientStorageContainer 内の getClientStorage

型パラメータ:

S - 記憶クラスの型

パラメータ:

key - ユーザ記憶クラスのキー

storageType - 記憶クラス

戻り値:

指定のキーに関連する記憶クラス

関連項目:

ClientStorageContainer.putClientStorage(Object, ClientStorage)

putClientStorage

public void putClientStorage(Object key,
                             ClientStorage newStorage)

インタフェース ClientStorageContainer の記述:

このオブジェクトに新しくユーザ記憶クラスを追加する。 newStorageにnullを指定した場合、記憶クラスは削除される。

定義:

インタフェース ClientStorageContainer 内の putClientStorage

パラメータ:

key - ユーザ記憶クラスのキー

newStorage - 追加する記憶クラス(Nullable)

toString

public String toString()

このモニタを実装するクラスの単純名を返す。

オーバーライド:

クラス Object 内の toString

戻り値:

このモニタを実装するクラスの単純名