- java.lang.Object
-
- javafx.concurrent.Service<V>
-
- 型パラメータ:
V
- サービスによって返されるオブジェクトの型
- すべての実装されたインタフェース:
Worker<V>
,EventTarget
- 直系の既知のサブクラス:
ScheduledService
public abstract class Service<V> extends Object implements Worker<V>, EventTarget
Serviceは、1つ以上のバックグラウンド・スレッドで処理を実行するために必要な情報をカプセル化する非ビジュアル・コンポーネントです。 JavaFX UIライブラリの一部として、ServiceはJavaFXアプリケーション・スレッドを認識し、ユーザー・インタフェースとやり取りするマルチスレッド・コードを管理する負荷からアプリケーション開発者を解放するように設計されています。 このため、Serviceのすべてのメソッドおよび状態は、JavaFXアプリケーション・スレッドからのみ呼び出されることが意図されています。 これに対する例外は、Serviceを最初に構成する場合とServiceを最初に起動する場合であり、これらは任意のスレッドから安全に実行できます。 ただし、Serviceが初期化および起動されると、以降はFXスレッドからのみ使用できます。
Serviceは、バックグラウンド・スレッドで処理を実行する
Task
を作成および管理します。 ServiceはWorker
を実装します。 このため、バックグラウンド・タスク操作の状態を監視し、必要に応じてそれを取り消すことができます。 Serviceは再利用可能なWorkerであり、リセットおよび再起動できます。 このため、Serviceは宣言的に構成し、必要に応じて再起動できます。 Serviceが起動すると、Taskをスケジュールし、Taskの状態の変化をリスニングします。 Taskは、Serviceを開始した参照を保留することはなく、つまり、Taskの実行はServiceが不要データの収集を実行するのを妨げません。Serviceに対して
Executor
が指定された場合、これはサービスを実際に実行するために使用されます。 それ以外の場合は、デーモン・スレッドが作成および実行されます。 デーモン以外のスレッドを作成する場合は、カスタムExecutorを指定します(たとえば、カスタムThreadFactory
を持つThreadPoolExecutor
を使用できます)。Serviceの目的は宣言的なユースケースを簡素化することであるため、サブクラスは実行する処理に対して入力パラメータをプロパティとして公開する必要があります。 たとえば、任意のURLから最初の行を読み取り、それを文字列として返すServiceを記述するとします。 そのようなServiceは、単一のプロパティ
url
を持つように定義される場合があります。 次のように実装される場合があります。public static class FirstLineService extends Service<String> { private StringProperty url = new SimpleStringProperty(this, "url"); public final void setUrl(String value) { url.set(value); } public final String getUrl() { return url.get(); } public final StringProperty urlProperty() { return url; } protected Task createTask() { final String _url = getUrl(); return new Task<String>() { protected String call() throws Exception { URL u = new URL(_url); BufferedReader in = new BufferedReader( new InputStreamReader(u.openStream())); String result = in.readLine(); in.close(); return result; } }; } }
Serviceは、デフォルトで、未指定のデフォルトまたは最大スレッド・プール・サイズを持つスレッド・プールExecutorを使用します。 これは、稚拙なコードによって数千のスレッドが作成されてシステムが完全に過負荷にならないようにするために行われます。
- 導入されたバージョン:
- JavaFX 2.0
-
-
プロパティのサマリー
プロパティ 型 プロパティ 説明 ReadOnlyObjectProperty<Throwable>
exception
発生した例外を表すReadOnlyObjectPropertyを取得します。ObjectProperty<Executor>
executor
このServiceを実行するために使用する実行者。ReadOnlyStringProperty
message
メッセージを表すReadOnlyStringPropertyを取得します。ObjectProperty<EventHandler<WorkerStateEvent>>
onCancelled
Task状態遷移がCANCELLED状態になるたびにonCancelledイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onFailed
Task状態遷移がFAILED状態になるたびにonFailedイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onReady
Task状態遷移がREADY状態になるたびにonReadyイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onRunning
Task状態遷移がRUNNING状態になるたびにonRunningイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onScheduled
Task状態遷移がSCHEDULED状態になるたびにonScheduleイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onSucceeded
Task状態遷移がSUCCEEDED状態になるたびにonSucceededイベント・ハンドラが呼び出されます。ReadOnlyDoubleProperty
progress
進捗を表すReadOnlyDoublePropertyを取得します。ReadOnlyBooleanProperty
running
Workerを実行しているかどうかを表すReadOnlyBooleanPropertyを取得します。ReadOnlyObjectProperty<Worker.State>
state
現在の状態を表すReadOnlyObjectPropertyを取得します。ReadOnlyStringProperty
title
タイトルを表すReadOnlyStringPropertyを取得します。ReadOnlyDoubleProperty
totalWork
実行する必要がある最大処理量を表すReadOnlyDoublePropertyを取得します。ReadOnlyObjectProperty<V>
value
値を表すReadOnlyObjectPropertyを取得します。ReadOnlyDoubleProperty
workDone
現在の進捗を表すReadOnlyDoublePropertyを取得します。
-
ネストされたクラスのサマリー
-
インタフェース javafx.concurrent.Workerから継承されたネストされたクラス/インタフェース
Worker.State
-
-
コンストラクタのサマリー
コンストラクタ 修飾子 コンストラクタ 説明 protected
Service()
新しいServiceを作成します。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 <T extends Event>
voidaddEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)
このタスクにイベント・フィルタを登録します。<T extends Event>
voidaddEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
このタスクにイベント・ハンドラを登録します。EventDispatchChain
buildEventDispatchChain(EventDispatchChain tail)
このターゲットのイベント・ディスパッチ・チェーンを構築します。boolean
cancel()
現在実行中のタスクを取り消します(存在する場合)。protected void
cancelled()
Serviceの状態がCANCELLED状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。protected abstract Task<V>
createTask()
ServiceがJavaFXアプリケーション・スレッドで起動された後に呼び出されます。ReadOnlyObjectProperty<Throwable>
exceptionProperty()
発生した例外を表すReadOnlyObjectPropertyを取得します。protected void
executeTask(Task<V> task)
このServiceに対して定義されたexecutor
を使用して、指定されたタスクを実行します。ObjectProperty<Executor>
executorProperty()
このServiceを実行するために使用する実行者。protected void
failed()
Serviceの状態がFAILED状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。protected void
fireEvent(Event event)
指定されたイベントを起動します。Throwable
getException()
プロパティexceptionの値を取得します。Executor
getExecutor()
プロパティexecutorの値を取得します。String
getMessage()
プロパティmessageの値を取得します。EventHandler<WorkerStateEvent>
getOnCancelled()
Task状態遷移がCANCELLED状態になるたびにonCancelledイベント・ハンドラが呼び出されます。EventHandler<WorkerStateEvent>
getOnFailed()
Task状態遷移がFAILED状態になるたびにonFailedイベント・ハンドラが呼び出されます。EventHandler<WorkerStateEvent>
getOnReady()
Task状態遷移がREADY状態になるたびにonReadyイベント・ハンドラが呼び出されます。EventHandler<WorkerStateEvent>
getOnRunning()
Task状態遷移がRUNNING状態になるたびにonRunningイベント・ハンドラが呼び出されます。EventHandler<WorkerStateEvent>
getOnScheduled()
Task状態遷移がSCHEDULED状態になるたびにonScheduleイベント・ハンドラが呼び出されます。EventHandler<WorkerStateEvent>
getOnSucceeded()
Task状態遷移がSUCCEEDED状態になるたびにonSucceededイベント・ハンドラが呼び出されます。double
getProgress()
プロパティprogressの値を取得します。Worker.State
getState()
プロパティstateの値を取得します。String
getTitle()
プロパティtitleの値を取得します。double
getTotalWork()
プロパティtotalWorkの値を取得します。V
getValue()
プロパティvalueの値を取得します。double
getWorkDone()
プロパティworkDoneの値を取得します。boolean
isRunning()
プロパティrunningの値を取得します。ReadOnlyStringProperty
messageProperty()
メッセージを表すReadOnlyStringPropertyを取得します。ObjectProperty<EventHandler<WorkerStateEvent>>
onCancelledProperty()
Task状態遷移がCANCELLED状態になるたびにonCancelledイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onFailedProperty()
Task状態遷移がFAILED状態になるたびにonFailedイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onReadyProperty()
Task状態遷移がREADY状態になるたびにonReadyイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onRunningProperty()
Task状態遷移がRUNNING状態になるたびにonRunningイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onScheduledProperty()
Task状態遷移がSCHEDULED状態になるたびにonScheduleイベント・ハンドラが呼び出されます。ObjectProperty<EventHandler<WorkerStateEvent>>
onSucceededProperty()
Task状態遷移がSUCCEEDED状態になるたびにonSucceededイベント・ハンドラが呼び出されます。ReadOnlyDoubleProperty
progressProperty()
進捗を表すReadOnlyDoublePropertyを取得します。protected void
ready()
Serviceの状態がREADY状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。<T extends Event>
voidremoveEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)
以前に登録したイベント・フィルタをこのタスクから登録解除します。<T extends Event>
voidremoveEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
以前に登録したイベント・ハンドラをこのタスクから登録解除します。void
reset()
Serviceをリセットします。void
restart()
現在実行中のタスクを取り消し(存在する場合)、このServiceを再起動します。protected void
running()
Serviceの状態がRUNNING状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。ReadOnlyBooleanProperty
runningProperty()
Workerを実行しているかどうかを表すReadOnlyBooleanPropertyを取得します。protected void
scheduled()
Serviceの状態がSCHEDULED状態に遷移するたびに呼び出される、protectedコンビニエンス・メソッド。protected <T extends Event>
voidsetEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
このイベント・タイプに対して使用するハンドラを設定します。void
setExecutor(Executor value)
プロパティexecutorの値を設定します。void
setOnCancelled(EventHandler<WorkerStateEvent> value)
Task状態遷移がCANCELLED状態になるたびにonCancelledイベント・ハンドラが呼び出されます。void
setOnFailed(EventHandler<WorkerStateEvent> value)
Task状態遷移がFAILED状態になるたびにonFailedイベント・ハンドラが呼び出されます。void
setOnReady(EventHandler<WorkerStateEvent> value)
Task状態遷移がREADY状態になるたびにonReadyイベント・ハンドラが呼び出されます。void
setOnRunning(EventHandler<WorkerStateEvent> value)
Task状態遷移がRUNNING状態になるたびにonRunningイベント・ハンドラが呼び出されます。void
setOnScheduled(EventHandler<WorkerStateEvent> value)
Task状態遷移がSCHEDULED状態になるたびにonScheduleイベント・ハンドラが呼び出されます。void
setOnSucceeded(EventHandler<WorkerStateEvent> value)
Task状態遷移がSUCCEEDED状態になるたびにonSucceededイベント・ハンドラが呼び出されます。void
start()
このServiceを起動します。ReadOnlyObjectProperty<Worker.State>
stateProperty()
現在の状態を表すReadOnlyObjectPropertyを取得します。protected void
succeeded()
Serviceの状態がSUCCEEDED状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。ReadOnlyStringProperty
titleProperty()
タイトルを表すReadOnlyStringPropertyを取得します。ReadOnlyDoubleProperty
totalWorkProperty()
実行する必要がある最大処理量を表すReadOnlyDoublePropertyを取得します。ReadOnlyObjectProperty<V>
valueProperty()
値を表すReadOnlyObjectPropertyを取得します。ReadOnlyDoubleProperty
workDoneProperty()
現在の進捗を表すReadOnlyDoublePropertyを取得します。
-
-
-
プロパティの詳細
-
state
public final ReadOnlyObjectProperty<Worker.State> stateProperty
- 定義:
stateProperty
、インタフェース:Worker<V>
- 関連項目:
getState()
-
value
public final ReadOnlyObjectProperty<V> valueProperty
- 定義:
valueProperty
、インタフェース:Worker<V>
- 関連項目:
getValue()
-
exception
public final ReadOnlyObjectProperty<Throwable> exceptionProperty
- 定義:
exceptionProperty
、インタフェース:Worker<V>
- 関連項目:
getException()
-
workDone
public final ReadOnlyDoubleProperty workDoneProperty
- 定義:
workDoneProperty
、インタフェース:Worker<V>
- 関連項目:
getWorkDone()
-
totalWork
public final ReadOnlyDoubleProperty totalWorkProperty
- 定義:
totalWorkProperty
、インタフェース:Worker<V>
- 関連項目:
getTotalWork()
-
progress
public final ReadOnlyDoubleProperty progressProperty
- 定義:
progressProperty
、インタフェース:Worker<V>
- 関連項目:
getProgress()
-
running
public final ReadOnlyBooleanProperty runningProperty
- 定義:
runningProperty
、インタフェース:Worker<V>
- 関連項目:
isRunning()
-
message
public final ReadOnlyStringProperty messageProperty
- 定義:
messageProperty
、インタフェース:Worker<V>
- 関連項目:
getMessage()
-
title
public final ReadOnlyStringProperty titleProperty
- 定義:
titleProperty
、インタフェース:Worker<V>
- 関連項目:
getTitle()
-
executor
public final ObjectProperty<Executor> executorProperty
このServiceを実行するために使用する実行者。 実行者が指定されない場合、新しいデーモン・スレッドが作成され、デフォルトの実行者を使用したServiceの実行に使用されます。
-
onReady
public final ObjectProperty<EventHandler<WorkerStateEvent>> onReadyProperty
Task状態遷移がREADY状態になるたびにonReadyイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnReady()
,setOnReady(EventHandler)
-
onScheduled
public final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduledProperty
Task状態遷移がSCHEDULED状態になるたびにonScheduleイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnScheduled()
,setOnScheduled(EventHandler)
-
onRunning
public final ObjectProperty<EventHandler<WorkerStateEvent>> onRunningProperty
Task状態遷移がRUNNING状態になるたびにonRunningイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnRunning()
,setOnRunning(EventHandler)
-
onSucceeded
public final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceededProperty
Task状態遷移がSUCCEEDED状態になるたびにonSucceededイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnSucceeded()
,setOnSucceeded(EventHandler)
-
onCancelled
public final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelledProperty
Task状態遷移がCANCELLED状態になるたびにonCancelledイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnCancelled()
,setOnCancelled(EventHandler)
-
onFailed
public final ObjectProperty<EventHandler<WorkerStateEvent>> onFailedProperty
Task状態遷移がFAILED状態になるたびにonFailedイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnFailed()
,setOnFailed(EventHandler)
-
-
メソッドの詳細
-
getState
public final Worker.State getState()
プロパティstateの値を取得します。
-
stateProperty
public final ReadOnlyObjectProperty<Worker.State> stateProperty()
次のインタフェースからコピーされた説明:Worker
現在の状態を表すReadOnlyObjectPropertyを取得します。- 定義:
stateProperty
、インタフェース:Worker<V>
- 関連項目:
getState()
-
getValue
public final V getValue()
プロパティvalueの値を取得します。
-
valueProperty
public final ReadOnlyObjectProperty<V> valueProperty()
次のインタフェースからコピーされた説明:Worker
値を表すReadOnlyObjectPropertyを取得します。- 定義:
valueProperty
、インタフェース:Worker<V>
- 関連項目:
getValue()
-
getException
public final Throwable getException()
プロパティexceptionの値を取得します。- 定義:
getException
、インタフェース:Worker<V>
- プロパティの説明:
- 戻り値:
- 例外(発生した場合)
-
exceptionProperty
public final ReadOnlyObjectProperty<Throwable> exceptionProperty()
次のインタフェースからコピーされた説明:Worker
発生した例外を表すReadOnlyObjectPropertyを取得します。- 定義:
exceptionProperty
、インタフェース:Worker<V>
- 関連項目:
getException()
-
getWorkDone
public final double getWorkDone()
プロパティworkDoneの値を取得します。- 定義:
getWorkDone
、インタフェース:Worker<V>
- プロパティの説明:
- 戻り値:
- 実行された処理量
- 関連項目:
Worker.totalWorkProperty()
,Worker.progressProperty()
-
workDoneProperty
public final ReadOnlyDoubleProperty workDoneProperty()
次のインタフェースからコピーされた説明:Worker
現在の進捗を表すReadOnlyDoublePropertyを取得します。- 定義:
workDoneProperty
、インタフェース:Worker<V>
- 関連項目:
getWorkDone()
-
getTotalWork
public final double getTotalWork()
プロパティtotalWorkの値を取得します。- 定義:
getTotalWork
、インタフェース:Worker<V>
- プロパティの説明:
- 戻り値:
- 実行される処理合計
- 関連項目:
Worker.workDoneProperty()
,Worker.progressProperty()
-
totalWorkProperty
public final ReadOnlyDoubleProperty totalWorkProperty()
次のインタフェースからコピーされた説明:Worker
実行する必要がある最大処理量を表すReadOnlyDoublePropertyを取得します。 これらの処理単位は、ダウンロードする必要があるバイト数や処理するイメージ数、その他のこのようなメトリックなど、Worker実装にとって意味を持ちます。- 定義:
totalWorkProperty
、インタフェース:Worker<V>
- 関連項目:
getTotalWork()
-
getProgress
public final double getProgress()
プロパティprogressの値を取得します。- 定義:
getProgress
、インタフェース:Worker<V>
- プロパティの説明:
- 戻り値:
- 現在の進捗
- 関連項目:
Worker.workDoneProperty()
,Worker.totalWorkProperty()
-
progressProperty
public final ReadOnlyDoubleProperty progressProperty()
次のインタフェースからコピーされた説明:Worker
進捗を表すReadOnlyDoublePropertyを取得します。- 定義:
progressProperty
、インタフェース:Worker<V>
- 関連項目:
getProgress()
-
isRunning
public final boolean isRunning()
プロパティrunningの値を取得します。
-
runningProperty
public final ReadOnlyBooleanProperty runningProperty()
次のインタフェースからコピーされた説明:Worker
Workerを実行しているかどうかを表すReadOnlyBooleanPropertyを取得します。- 定義:
runningProperty
、インタフェース:Worker<V>
- 関連項目:
isRunning()
-
getMessage
public final String getMessage()
プロパティmessageの値を取得します。- 定義:
getMessage
、インタフェース:Worker<V>
- プロパティの説明:
- 戻り値:
- 現在のメッセージ
-
messageProperty
public final ReadOnlyStringProperty messageProperty()
次のインタフェースからコピーされた説明:Worker
メッセージを表すReadOnlyStringPropertyを取得します。- 定義:
messageProperty
、インタフェース:Worker<V>
- 関連項目:
getMessage()
-
getTitle
public final String getTitle()
プロパティtitleの値を取得します。
-
titleProperty
public final ReadOnlyStringProperty titleProperty()
次のインタフェースからコピーされた説明:Worker
タイトルを表すReadOnlyStringPropertyを取得します。- 定義:
titleProperty
、インタフェース:Worker<V>
- 関連項目:
getTitle()
-
setExecutor
public final void setExecutor(Executor value)
プロパティexecutorの値を設定します。- プロパティの説明:
- このServiceを実行するために使用する実行者。 実行者が指定されない場合、新しいデーモン・スレッドが作成され、デフォルトの実行者を使用したServiceの実行に使用されます。
-
getExecutor
public final Executor getExecutor()
プロパティexecutorの値を取得します。- プロパティの説明:
- このServiceを実行するために使用する実行者。 実行者が指定されない場合、新しいデーモン・スレッドが作成され、デフォルトの実行者を使用したServiceの実行に使用されます。
-
executorProperty
public final ObjectProperty<Executor> executorProperty()
このServiceを実行するために使用する実行者。 実行者が指定されない場合、新しいデーモン・スレッドが作成され、デフォルトの実行者を使用したServiceの実行に使用されます。
-
onReadyProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onReadyProperty()
Task状態遷移がREADY状態になるたびにonReadyイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnReady()
,setOnReady(EventHandler)
-
getOnReady
public final EventHandler<WorkerStateEvent> getOnReady()
Task状態遷移がREADY状態になるたびにonReadyイベント・ハンドラが呼び出されます。- 戻り値:
- onReadyイベント・ハンドラ(存在する場合)
- 導入されたバージョン:
- JavaFX 2.1
-
setOnReady
public final void setOnReady(EventHandler<WorkerStateEvent> value)
Task状態遷移がREADY状態になるたびにonReadyイベント・ハンドラが呼び出されます。- パラメータ:
value
- イベント・ハンドラ(nullにしてクリアすることが可能)- 導入されたバージョン:
- JavaFX 2.1
-
ready
protected void ready()
Serviceの状態がREADY状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。 このメソッドは、Serviceが新しい状態に完全に遷移した後に呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
-
onScheduledProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduledProperty()
Task状態遷移がSCHEDULED状態になるたびにonScheduleイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnScheduled()
,setOnScheduled(EventHandler)
-
getOnScheduled
public final EventHandler<WorkerStateEvent> getOnScheduled()
Task状態遷移がSCHEDULED状態になるたびにonScheduleイベント・ハンドラが呼び出されます。- 戻り値:
- onScheduledイベント・ハンドラ(存在する場合)
- 導入されたバージョン:
- JavaFX 2.1
-
setOnScheduled
public final void setOnScheduled(EventHandler<WorkerStateEvent> value)
Task状態遷移がSCHEDULED状態になるたびにonScheduleイベント・ハンドラが呼び出されます。- パラメータ:
value
- イベント・ハンドラ(nullにしてクリアすることが可能)- 導入されたバージョン:
- JavaFX 2.1
-
scheduled
protected void scheduled()
Serviceの状態がSCHEDULED状態に遷移するたびに呼び出される、protectedコンビニエンス・メソッド。 このメソッドは、Serviceが新しい状態に完全に遷移した後に呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
-
onRunningProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onRunningProperty()
Task状態遷移がRUNNING状態になるたびにonRunningイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnRunning()
,setOnRunning(EventHandler)
-
getOnRunning
public final EventHandler<WorkerStateEvent> getOnRunning()
Task状態遷移がRUNNING状態になるたびにonRunningイベント・ハンドラが呼び出されます。- 戻り値:
- onRunningイベント・ハンドラ(存在する場合)
- 導入されたバージョン:
- JavaFX 2.1
-
setOnRunning
public final void setOnRunning(EventHandler<WorkerStateEvent> value)
Task状態遷移がRUNNING状態になるたびにonRunningイベント・ハンドラが呼び出されます。- パラメータ:
value
- イベント・ハンドラ(nullにしてクリアすることが可能)- 導入されたバージョン:
- JavaFX 2.1
-
running
protected void running()
Serviceの状態がRUNNING状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。 このメソッドは、Serviceが新しい状態に完全に遷移した後に呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
-
onSucceededProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceededProperty()
Task状態遷移がSUCCEEDED状態になるたびにonSucceededイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnSucceeded()
,setOnSucceeded(EventHandler)
-
getOnSucceeded
public final EventHandler<WorkerStateEvent> getOnSucceeded()
Task状態遷移がSUCCEEDED状態になるたびにonSucceededイベント・ハンドラが呼び出されます。- 戻り値:
- onSucceededイベント・ハンドラ(存在する場合)
- 導入されたバージョン:
- JavaFX 2.1
-
setOnSucceeded
public final void setOnSucceeded(EventHandler<WorkerStateEvent> value)
Task状態遷移がSUCCEEDED状態になるたびにonSucceededイベント・ハンドラが呼び出されます。- パラメータ:
value
- イベント・ハンドラ(nullにしてクリアすることが可能)- 導入されたバージョン:
- JavaFX 2.1
-
succeeded
protected void succeeded()
Serviceの状態がSUCCEEDED状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。 このメソッドは、Serviceが新しい状態に完全に遷移した後に呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
-
onCancelledProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelledProperty()
Task状態遷移がCANCELLED状態になるたびにonCancelledイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnCancelled()
,setOnCancelled(EventHandler)
-
getOnCancelled
public final EventHandler<WorkerStateEvent> getOnCancelled()
Task状態遷移がCANCELLED状態になるたびにonCancelledイベント・ハンドラが呼び出されます。- 戻り値:
- onCancelledイベント・ハンドラ(存在する場合)
- 導入されたバージョン:
- JavaFX 2.1
-
setOnCancelled
public final void setOnCancelled(EventHandler<WorkerStateEvent> value)
Task状態遷移がCANCELLED状態になるたびにonCancelledイベント・ハンドラが呼び出されます。- パラメータ:
value
- イベント・ハンドラ(nullにしてクリアすることが可能)- 導入されたバージョン:
- JavaFX 2.1
-
cancelled
protected void cancelled()
Serviceの状態がCANCELLED状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。 このメソッドは、Serviceが新しい状態に完全に遷移した後に呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
-
onFailedProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onFailedProperty()
Task状態遷移がFAILED状態になるたびにonFailedイベント・ハンドラが呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
- 関連項目:
getOnFailed()
,setOnFailed(EventHandler)
-
getOnFailed
public final EventHandler<WorkerStateEvent> getOnFailed()
Task状態遷移がFAILED状態になるたびにonFailedイベント・ハンドラが呼び出されます。- 戻り値:
- onFailedイベント・ハンドラ(存在する場合)
- 導入されたバージョン:
- JavaFX 2.1
-
setOnFailed
public final void setOnFailed(EventHandler<WorkerStateEvent> value)
Task状態遷移がFAILED状態になるたびにonFailedイベント・ハンドラが呼び出されます。- パラメータ:
value
- イベント・ハンドラ(nullにしてクリアすることが可能)- 導入されたバージョン:
- JavaFX 2.1
-
failed
protected void failed()
Serviceの状態がFAILED状態に遷移するたびに呼び出される、サブクラスのprotectedコンビニエンス・メソッド。 このメソッドは、Serviceが新しい状態に完全に遷移した後に呼び出されます。- 導入されたバージョン:
- JavaFX 2.1
-
cancel
public boolean cancel()
現在実行中のタスクを取り消します(存在する場合)。 状態はCANCELLEDに設定されます。
-
restart
public void restart()
現在実行中のタスクを取り消し(存在する場合)、このServiceを再起動します。 実行前に状態はREADYにリセットされます。 このメソッドは、FXアプリケーション・スレッドでのみ呼び出す必要があります。
-
reset
public void reset()
Serviceをリセットします。 終了状態(SUCCEEDED、FAILEDまたはCANCELLED)のいずれかのとき、またはREADYのときにのみ呼び出すことができます。 このメソッドは、FXアプリケーション・スレッドでのみ呼び出す必要があります。
-
start
public void start()
このServiceを起動します。 この呼出しに成功するには、ServiceはREADY状態である必要があります。 このメソッドは、FXアプリケーション・スレッドでのみ呼び出す必要があります。
-
executeTask
protected void executeTask(Task<V> task)
このServiceに対して定義された
executor
を使用して、指定されたタスクを実行します。executor
がnullの場合、このタスクを実行する新しいデーモン・スレッドを作成するデフォルトの実行者が使用されます。このメソッドは、Service実装による呼出しのみが意図されています。
- パラメータ:
task
- 実行するnull以外のタスク- 導入されたバージョン:
- JavaFX 2.1
-
addEventHandler
public final <T extends Event> void addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
このタスクにイベント・ハンドラを登録します。 イベント・フィルタが最初に処理されてから、指定されたonFooイベント・ハンドラ、最後にこのメソッドによって登録されたイベント・ハンドラが処理されます。 シーン・グラフの他のイベントと同様に、イベントが使用されると、ディスパッチは続行されなくなります。- 型パラメータ:
T
- ハンドラの特定のイベント・クラス- パラメータ:
eventType
- ハンドラによって受け取る特定のイベントのタイプeventHandler
- 登録するハンドラ- 例外:
NullPointerException
- イベント・タイプまたはハンドラがnullの場合- 導入されたバージョン:
- JavaFX 2.1
-
removeEventHandler
public final <T extends Event> void removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
以前に登録したイベント・ハンドラをこのタスクから登録解除します。 1つのハンドラが様々なイベント・タイプに登録されている場合があるため、呼出し元はハンドラを登録解除する特定のイベント・タイプを指定する必要があります。- 型パラメータ:
T
- ハンドラの特定のイベント・クラス- パラメータ:
eventType
- 登録解除する対象のイベント・タイプeventHandler
- 登録解除するハンドラ- 例外:
NullPointerException
- イベント・タイプまたはハンドラがnullの場合- 導入されたバージョン:
- JavaFX 2.1
-
addEventFilter
public final <T extends Event> void addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)
このタスクにイベント・フィルタを登録します。 登録されたイベント・フィルタは、関連付けられたイベント・ハンドラよりも前にイベントを取得します。- 型パラメータ:
T
- フィルタの特定のイベント・クラス- パラメータ:
eventType
- フィルタによって受け取る特定のイベントのタイプeventFilter
- 登録するフィルタ- 例外:
NullPointerException
- イベント・タイプまたはフィルタがnullの場合- 導入されたバージョン:
- JavaFX 2.1
-
removeEventFilter
public final <T extends Event> void removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)
以前に登録したイベント・フィルタをこのタスクから登録解除します。 1つのフィルタが様々なイベント・タイプに登録されている場合があるため、呼出し元はフィルタを登録解除する特定のイベント・タイプを指定する必要があります。- 型パラメータ:
T
- フィルタの特定のイベント・クラス- パラメータ:
eventType
- 登録解除する対象のイベント・タイプeventFilter
- 登録解除するフィルタ- 例外:
NullPointerException
- イベント・タイプまたはフィルタがnullの場合- 導入されたバージョン:
- JavaFX 2.1
-
setEventHandler
protected final <T extends Event> void setEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
このイベント・タイプに対して使用するハンドラを設定します。 このようなハンドラは一度に1つのみ指定できます。 このハンドラは必ず最初に呼び出されます。 これは、ユーザー定義のonFooイベント・ハンドラの登録に使用されます。- 型パラメータ:
T
- ハンドラの特定のイベント・クラス- パラメータ:
eventType
- 特定のeventHandlerと関連付けるイベント・タイプeventHandler
- 登録するハンドラ、または登録解除する場合はnull- 例外:
NullPointerException
- イベント・タイプがnullの場合- 導入されたバージョン:
- JavaFX 2.1
-
fireEvent
protected final void fireEvent(Event event)
指定されたイベントを起動します。 検出されたイベント・フィルタに通知され、イベント・フィルタはイベントを使用できます。 フィルタが使用しない場合は、このタスクのイベント・ハンドラに通知されます。 これらもイベントを使用しない場合は、すべてのイベント・ハンドラが呼び出されてイベントを使用できます。このメソッドは、FXユーザー・スレッドで呼び出す必要があります。
- パラメータ:
event
- 起動するイベント- 導入されたバージョン:
- JavaFX 2.1
-
buildEventDispatchChain
public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)
次のインタフェースからコピーされた説明:EventTarget
このターゲットのイベント・ディスパッチ・チェーンを構築します。 イベント・ディスパッチ・チェーンには、このEventTarget
を対象にしたイベントの処理に関係する可能性があるイベント・ディスパッチャが含まれます。 このイベント・ターゲットはチェーンに自動的には追加されないため、これがイベントを処理する場合は、それ自体のEventDispatcher
をチェーンに追加する必要があります。イベント・ターゲットが階層の一部である場合、そのチェーンは通常、階層のルートからイベント・ターゲットまでの収集されたイベント・ディスパッチャから作成されます。
イベント・ディスパッチ・チェーンは、提供される初期イベント・ディスパッチ・チェーンに対する変更によって構築されます。 返されるチェーンでは初期チェーンが最後にある必要があるため、ディスパッチャは初期チェーンの前に追加される必要があります。
呼出し元は、初期チェーンが変更されないままであることや、返される値によって異なるチェーンが参照されることを想定できません。
- 定義:
buildEventDispatchChain
、インタフェース:EventTarget
- パラメータ:
tail
- 作成元の初期チェーン- 戻り値:
- このターゲットの結果のイベント・ディスパッチ・チェーン
-
createTask
protected abstract Task<V> createTask()
ServiceがJavaFXアプリケーション・スレッドで起動された後に呼び出されます。 Taskのバックグラウンド・スレッド・コード内でServiceで定義されたプロパティにアクセスすると例外になるため、実装ではTaskを作成する前に状態をfinal変数に保存する必要があります。 次に例を示します。protected Task createTask() { final String url = myService.getUrl(); return new Task<String>() { protected String call() { URL u = new URL("http://www.oracle.com"); BufferedReader in = new BufferedReader( new InputStreamReader(u.openStream())); String result = in.readLine(); in.close(); return result; } } }
Taskが(匿名クラスではなく)事前定義済クラスである場合、および推奨されるベストプラクティスに従った場合、その状態はそのコンストラクタで完全に提供されるため、Taskを構築する前に状態を保存する必要はありません。
protected Task createTask() { // This is safe because getUrl is called on the FX Application // Thread and the FirstLineReaderTasks stores it as an // immutable property return new FirstLineReaderTask(myService.getUrl()); }
- 戻り値:
- 実行するTask
-
-