Класс Service<V>
- javafx.concurrent.Service<V>
Параметры типа:
V -
Все реализуемые интерфейсы:
Worker<V>, EventTarget
Прямые известные подклассы:
public abstract class Service<V> extends Object implements Worker<V>, EventTarget
Сервис — это компонент, не отображаемый визуально, который инкапсулирует информацию, необходимую для выполнения некоторой работы в одном или нескольких фоновых потоках. В качестве части библиотеки пользовательского интерфейса JavaFX, сервис знает о потоке приложения JavaFX и предназначен для освобождения разработчика приложения от необходимости управления многопоточным кодом, взаимодействующим с пользовательским интерфейсом. Таким образом, все методы и состояния сервиса предназначены для вызова исключительно из потока приложения JavaFX. Единственное исключение из этого правила — первоначальная настройка сервиса, которая может безопасно выполняться из любого потока, и первоначальный запуск сервиса, который также может безопасно выполняться из любого потока. Однако после инициализации и запуска сервиса им можно пользоваться только из потока FX.
Сервис создаёт и управляет задачей Task, которая выполняет работу в фоновом потоке. Сервис реализует Worker. Таким образом, можно наблюдать за состоянием фоновой задачи и, при необходимости, отменить её. Сервис является многоразовой задачей, что означает, что его можно сбросить и перезапустить. Благодаря этому, сервис можно создавать декларативно и перезапускать по требованию. После запуска сервиса он запланирует свою задачу и будет отслеживать изменения состояния задачи. Задача не хранит ссылку на сервис, который её запустил, что означает, что выполняющаяся задача не помешает сервису быть удалённым из памяти.
Если для сервиса указан Executor, то он будет использован для фактического выполнения сервиса. В противном случае будет создан и запущен демонический поток. Если вы хотите создать потоки, которые не являются демоническими, укажите пользовательский Executor (например, вы можете использовать ThreadPoolExecutor с пользовательской ThreadFactory).
Поскольку сервис предназначен для упрощения декларативных сценариев использования, подклассы должны предоставлять свойства, являющиеся входными параметрами для выполняемой работы. Например, предположим, что я хочу написать сервис, который считывает первую строку из любого URL и возвращает её в виде строки. Такой сервис можно определить таким образом, чтобы он имел одно свойство, 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;
}
};
}
} По умолчанию сервис использует пул потоков Executor с каким-то неопределённым значением по умолчанию или максимальным размером пула потоков. Это делается для того, чтобы код по умолчанию не перегружал систему, создавая тысячи потоков.
С тех пор:
JavaFX 2.0
-
Краткое описание свойств
Все методыМетоды экземпляраКонкретные методы Тип Свойство и описание ReadOnlyObjectProperty<Throwable>exceptionВозвращает ReadOnlyObjectProperty, представляющее любую возникшую ошибку.ObjectProperty<Executor>executorИсполнитель, который необходимо использовать для запуска этого сервиса.ReadOnlyStringPropertymessageВозвращает ReadOnlyStringProperty, представляющую сообщение.ObjectProperty<EventHandler<WorkerStateEvent>>onCancelledОбработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.ObjectProperty<EventHandler<WorkerStateEvent>>onFailedОбработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.ObjectProperty<EventHandler<WorkerStateEvent>>onReadyОбработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.ObjectProperty<EventHandler<WorkerStateEvent>>onRunningОбработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.ObjectProperty<EventHandler<WorkerStateEvent>>onScheduledОбработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.ObjectProperty<EventHandler<WorkerStateEvent>>onSucceededОбработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.ReadOnlyDoublePropertyprogressВозвращает ReadOnlyDoubleProperty, представляющее прогресс.ReadOnlyBooleanPropertyrunningВозвращает ReadOnlyBooleanProperty, представляющее, работает ли Worker.ReadOnlyObjectProperty<Worker.State>stateВозвращает ReadOnlyObjectProperty, представляющее текущее состояние.ReadOnlyStringPropertytitleВозвращает ReadOnlyStringProperty, представляющее заголовок.ReadOnlyDoublePropertytotalWorkВозвращает ReadOnlyDoubleProperty, представляющее максимальное количество работы, которое необходимо выполнить.ReadOnlyObjectProperty<V>valueВозвращает ReadOnlyObjectProperty, представляющее значение.ReadOnlyDoublePropertyworkDoneВозвращает ReadOnlyDoubleProperty, представляющее текущий прогресс.
-
Краткое описание вложенных классов
-
Вложенные классы/интерфейсы, унаследованные от интерфейса javafx.concurrent.Worker
Worker.State
-
-
Краткое описание конструкторов
Конструкторы Модификатор Конструктор и описание protectedService()Создаёт новый сервис.
-
Краткое описание методов
Все методыМетоды экземпляровАбстрактные методыКонкретные методы Модификатор и тип Метод и описание <T extends Event>
voidaddEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)Регистрирует фильтр событий для этой задачи.<T extends Event>
voidaddEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)Регистрирует обработчик событий для этой задачи.EventDispatchChainbuildEventDispatchChain(EventDispatchChain tail)Создаёт цепочку обработки событий для этой цели.booleancancel()Отменяет любую текущую выполняющуюся задачу, если таковая есть.protected voidcancelled()Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние CANCELLED.protected abstract Task<V>createTask()Вызывается после запуска службы в потоке приложения JavaFX.ReadOnlyObjectProperty<Throwable>exceptionProperty()Возвращает ReadOnlyObjectProperty, представляющий любую произошедшую ошибку.protected voidexecuteTask(Task<V> task)Используетexecutor, определённый в этой службе, для выполнения заданной задачи.ObjectProperty<Executor>executorProperty()Исполнитель, используемый для выполнения этой службы.protected voidfailed()Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние FAILED.protected voidfireEvent(Event event)Вызывает указанное событие.ThrowablegetException()Возвращает значение свойства exception.ExecutorgetExecutor()Возвращает значение свойства executor.StringgetMessage()Возвращает значение свойства message.EventHandler<WorkerStateEvent>getOnCancelled()Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.EventHandler<WorkerStateEvent>getOnFailed()Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.EventHandler<WorkerStateEvent>getOnReady()Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.EventHandler<WorkerStateEvent>getOnRunning()Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.EventHandler<WorkerStateEvent>getOnScheduled()Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.EventHandler<WorkerStateEvent>getOnSucceeded()Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.doublegetProgress()Возвращает значение свойства progress.Worker.StategetState()Возвращает значение свойства state.StringgetTitle()Возвращает значение свойства title.doublegetTotalWork()Возвращает значение свойства totalWork.VgetValue()Возвращает значение свойства value.doublegetWorkDone()Возвращает значение свойства workDone.booleanisRunning()Возвращает значение свойства running.ReadOnlyStringPropertymessageProperty()Возвращает ReadOnlyStringProperty, представляющий сообщение.ObjectProperty<EventHandler<WorkerStateEvent>>onCancelledProperty()Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.ObjectProperty<EventHandler<WorkerStateEvent>>onFailedProperty()Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.ObjectProperty<EventHandler<WorkerStateEvent>>onReadyProperty()Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.ObjectProperty<EventHandler<WorkerStateEvent>>onRunningProperty()Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.ObjectProperty<EventHandler<WorkerStateEvent>>onScheduledProperty()Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.ObjectProperty<EventHandler<WorkerStateEvent>>onSucceededProperty()Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.ReadOnlyDoublePropertyprogressProperty()Возвращает ReadOnlyDoubleProperty, представляющий прогресс.protected voidready()Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние READY.<T extends Event>
voidremoveEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)Отменяет ранее зарегистрированный фильтр событий из этой задачи.<T extends Event>
voidremoveEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)Отменяет ранее зарегистрированный обработчик событий из этой задачи.voidreset()Сбрасывает состояние службы.voidrestart()Отменяет любую текущую выполняющуюся задачу, если таковая есть, и перезапускает эту службу.protected voidrunning()Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние RUNNING.ReadOnlyBooleanPropertyrunningProperty()Возвращает ReadOnlyBooleanProperty, представляющий, запущена ли задача.protected voidscheduled()Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние SCHEDULED.protected <T extends Event>
voidsetEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)Устанавливает обработчик для использования с этим типом события.voidsetExecutor(Executor value)Устанавливает значение свойства executor.voidsetOnCancelled(EventHandler<WorkerStateEvent> value)Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.voidsetOnFailed(EventHandler<WorkerStateEvent> value)Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.voidsetOnReady(EventHandler<WorkerStateEvent> value)Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.voidsetOnRunning(EventHandler<WorkerStateEvent> value)Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.voidsetOnScheduled(EventHandler<WorkerStateEvent> value)Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.voidsetOnSucceeded(EventHandler<WorkerStateEvent> value)Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.voidstart()Запускает эту службу.ReadOnlyObjectProperty<Worker.State>stateProperty()Возвращает ReadOnlyObjectProperty, представляющий текущее состояние.protected voidsucceeded()Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние SUCCEEDED.ReadOnlyStringPropertytitleProperty()Возвращает ReadOnlyStringProperty, представляющий заголовок.ReadOnlyDoublePropertytotalWorkProperty()Возвращает ReadOnlyDoubleProperty, представляющий максимальное количество работы, которое необходимо выполнить.ReadOnlyObjectProperty<V>valueProperty()Возвращает ReadOnlyObjectProperty, представляющий значение.ReadOnlyDoublePropertyworkDoneProperty()Возвращает ReadOnlyDoubleProperty, представляющий текущий прогресс.
-
Подробное описание свойств
-
state
public final ReadOnlyObjectProperty<Worker.State> stateProperty
Определено:
statePropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее состояние
См. также:
-
value
public final ReadOnlyObjectProperty<V> valueProperty
Определено:
valuePropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее текущее значение
См. также:
-
exception
public final ReadOnlyObjectProperty<Throwable> exceptionProperty
Определено:
exceptionPropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее исключение
См. также:
-
workDone
public final ReadOnlyDoubleProperty workDoneProperty
Определено:
workDonePropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее объём выполненной работы
См. также:
-
totalWork
public final ReadOnlyDoubleProperty totalWorkProperty
Определено:
totalWorkPropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее общий объём работы
См. также:
-
progress
public final ReadOnlyDoubleProperty progressProperty
Определено:
progressPropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее прогресс
См. также:
-
running
public final ReadOnlyBooleanProperty runningProperty
Определено:
runningPropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее, запущен ли рабочий процесс
См. также:
-
message
public final ReadOnlyStringProperty messageProperty
Определено:
messagePropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее текущее сообщение
См. также:
-
title
public final ReadOnlyStringProperty titleProperty
Определено:
titlePropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее текущий заголовок
См. также:
-
executor
public final ObjectProperty<Executor> executorProperty
Используемый исполняющий механизм для запуска этого сервиса. Если не указан, то будет создан новый демон-поток и использован для запуска сервиса с использованием некоторого стандартного исполняющего механизма.См. также:
-
onReady
public final ObjectProperty<EventHandler<WorkerStateEvent>> onReadyProperty
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.С:
JavaFX 2.1
См. также:
-
onScheduled
public final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduledProperty
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.С:
JavaFX 2.1
См. также:
-
onRunning
public final ObjectProperty<EventHandler<WorkerStateEvent>> onRunningProperty
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.С:
JavaFX 2.1
См. также:
-
onSucceeded
public final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceededProperty
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.С:
JavaFX 2.1
См. также:
-
onCancelled
public final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelledProperty
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.С:
JavaFX 2.1
См. также:
-
onFailed
public final ObjectProperty<EventHandler<WorkerStateEvent>> onFailedProperty
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.С:
JavaFX 2.1
См. также:
-
-
Подробное описание конструкторов
-
Service
protected Service()
Создаёт новый сервис.
-
-
Подробное описание метода
-
getState
public final Worker.State getState()
Получает значение свойства state.
-
stateProperty
public final ReadOnlyObjectProperty<Worker.State> stateProperty()
Описание скопировано из интерфейса:WorkerПолучает ReadOnlyObjectProperty, представляющее текущее состояние.Определено в:
statePropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее состояние
См. также:
-
getValue
public final V getValue()
Получает значение свойства value.
-
valueProperty
public final ReadOnlyObjectProperty<V> valueProperty()
Описание скопировано из интерфейса:WorkerПолучает ReadOnlyObjectProperty, представляющее значение.Определено в:
valuePropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее текущее значение
См. также:
-
getException
public final Throwable getException()
Получает значение свойства exception.Определено в:
getExceptionв интерфейсеWorker<V>Возвращает:
исключение, если оно возникло
-
exceptionProperty
public final ReadOnlyObjectProperty<Throwable> exceptionProperty()
Описание скопировано из интерфейса:WorkerПолучает ReadOnlyObjectProperty, представляющее любое возникшее исключение.Определено в:
exceptionPropertyв интерфейсеWorker<V>Возвращает:
свойство, представляющее исключение
См. также:
-
getWorkDone
public final double getWorkDone()
Получает значение свойства workDone.
-
workDoneProperty
public final ReadOnlyDoubleProperty workDoneProperty()
Описание скопировано из интерфейса:WorkerПолучает ReadOnlyDoubleProperty, представляющее текущий прогресс.Определено в:
workDonePropertyв интерфейсеWorker<V>Возвращает:
Свойство, представляющее объем выполненной работы
См. также:
-
getTotalWork
public final double getTotalWork()
Получает значение свойства totalWork.
-
totalWorkProperty
public final ReadOnlyDoubleProperty totalWorkProperty()
Описание скопировано из интерфейса:WorkerПолучает ReadOnlyDoubleProperty, представляющее максимальный объем работы, который необходимо выполнить. Эти «единицы работы» имеют значение для реализации Worker, например, количество байтов, которые необходимо загрузить, количество изображений для обработки или какой-либо другой показатель.Определено в:
totalWorkPropertyв интерфейсеWorker<V>Возвращает:
свойство, представляющее общий объем работы
См. также:
-
getProgress
public final double getProgress()
Получает значение свойства progress.
-
progressProperty
public final ReadOnlyDoubleProperty progressProperty()
Описание скопировано из интерфейса:WorkerПолучает ReadOnlyDoubleProperty, представляющее прогресс.Определено в:
progressPropertyв интерфейсеWorker<V>Возвращает:
свойство, представляющее прогресс
См. также:
-
isRunning
public final boolean isRunning()
Получает значение свойства running.
-
runningProperty
public final ReadOnlyBooleanProperty runningProperty()
Описание скопировано из интерфейса:WorkerПолучает ReadOnlyBooleanProperty, представляющее, запущен ли Worker.Определено в:
runningPropertyв интерфейсеWorker<V>Возвращает:
свойство, представляющее, запущен ли рабочий
См. также:
-
getMessage
public final String getMessage()
Получает значение свойства message.Определено в:
getMessageв интерфейсеWorker<V>Возвращает:
текущее сообщение
-
messageProperty
public final ReadOnlyStringProperty messageProperty()
Описание скопировано из интерфейса:WorkerПолучает ReadOnlyStringProperty, представляющее сообщение.Определено в:
messagePropertyв интерфейсеWorker<V>Возвращает:
свойство, представляющее текущее сообщение
См. также:
-
getTitle
public final String getTitle()
Получает значение свойства title.
-
titleProperty
public final ReadOnlyStringProperty titleProperty()
Описание скопировано из интерфейса:WorkerПолучает ReadOnlyStringProperty, представляющее название.Определено в:
titlePropertyв интерфейсеWorker<V>Возвращает:
свойство, представляющее текущее название
См. также:
-
setExecutor
public final void setExecutor(Executor value)
Устанавливает значение свойства executor.Описание свойства:
Исполнитель, используемый для запуска этого сервиса. Если исполнитель не указан, будет создан новый демон-поток и будет использован для запуска сервиса с помощью некоторого стандартного исполнителя.
-
getExecutor
public final Executor getExecutor()
Получает значение свойства executor.Описание свойства:
Исполнитель, используемый для запуска этого сервиса. Если исполнитель не указан, будет создан новый демон-поток и будет использован для запуска сервиса с помощью некоторого стандартного исполнителя.
-
executorProperty
public final ObjectProperty<Executor> executorProperty()
Исполнитель, используемый для запуска этого сервиса. Если исполнитель не указан, будет создан новый демон-поток и будет использован для запуска сервиса с помощью некоторого стандартного исполнителя.См. также:
-
onReadyProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onReadyProperty()
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.С момента:
JavaFX 2.1
См. также:
-
getOnReady
public final EventHandler<WorkerStateEvent> getOnReady()
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.Возвращает:
обработчик события onReady, если он есть
С момента:
JavaFX 2.1
-
setOnReady
public final void setOnReady(EventHandler<WorkerStateEvent> value)
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.Параметры:
value- обработчик события, может быть null для его очисткиС момента:
JavaFX 2.1
-
ready
protected void ready()
Защищенный вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние сервиса переходит в состояние READY. Этот метод вызывается после того, как сервис был полностью переведен в новое состояние.С момента:
JavaFX 2.1
-
-
onScheduledProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduledProperty()
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.С момента:
JavaFX 2.1
См. также:
-
getOnScheduled
public final EventHandler<WorkerStateEvent> getOnScheduled()
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.Возвращает:
обработчик события onScheduled, если таковой есть
С момента:
JavaFX 2.1
-
setOnScheduled
public final void setOnScheduled(EventHandler<WorkerStateEvent> value)
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.Параметры:
value- обработчик событий, может быть null для его очисткиС момента:
JavaFX 2.1
-
scheduled
protected void scheduled()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние SCHEDULED. Этот метод вызывается после того, как служба полностью перешла в новое состояние.С момента:
JavaFX 2.1
-
onRunningProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onRunningProperty()
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.С момента:
JavaFX 2.1
См. также:
-
getOnRunning
public final EventHandler<WorkerStateEvent> getOnRunning()
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.Возвращает:
обработчик события onRunning, если таковой есть
С момента:
JavaFX 2.1
-
setOnRunning
public final void setOnRunning(EventHandler<WorkerStateEvent> value)
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.Параметры:
value- обработчик событий, может быть null для его очисткиС момента:
JavaFX 2.1
-
running
protected void running()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние RUNNING. Этот метод вызывается после того, как служба полностью перешла в новое состояние.С момента:
JavaFX 2.1
-
onSucceededProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceededProperty()
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.С момента:
JavaFX 2.1
См. также:
-
getOnSucceeded
public final EventHandler<WorkerStateEvent> getOnSucceeded()
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.Возвращает:
обработчик события onSucceeded, если таковой есть
С момента:
JavaFX 2.1
-
setOnSucceeded
public final void setOnSucceeded(EventHandler<WorkerStateEvent> value)
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.Параметры:
value- обработчик событий, может быть null для его очисткиС момента:
JavaFX 2.1
-
succeeded
protected void succeeded()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние SUCCEEDED. Этот метод вызывается после того, как служба полностью перешла в новое состояние.С момента:
JavaFX 2.1
-
onCancelledProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelledProperty()
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.С момента:
JavaFX 2.1
См. также:
-
getOnCancelled
public final EventHandler<WorkerStateEvent> getOnCancelled()
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.Возвращает:
обработчик события onCancelled, если таковой есть
С момента:
JavaFX 2.1
-
setOnCancelled
public final void setOnCancelled(EventHandler<WorkerStateEvent> value)
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.Параметры:
value- обработчик событий, может быть null для его очисткиС момента:
JavaFX 2.1
-
cancelled
protected void cancelled()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние CANCELLED. Этот метод вызывается после того, как служба полностью перешла в новое состояние.С момента:
JavaFX 2.1
-
onFailedProperty
public final ObjectProperty<EventHandler<WorkerStateEvent>> onFailedProperty()
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.С момента:
JavaFX 2.1
См. также:
-
getOnFailed
public final EventHandler<WorkerStateEvent> getOnFailed()
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.Возвращает:
обработчик события onFailed, если таковой есть
С момента:
JavaFX 2.1
-
setOnFailed
public final void setOnFailed(EventHandler<WorkerStateEvent> value)
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.Параметры:
value- обработчик событий, может быть null для его очисткиС момента:
JavaFX 2.1
-
failed
protected void failed()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние FAILED. Этот метод вызывается после того, как служба полностью перешла в новое состояние.С момента:
JavaFX 2.1
-
cancel
public boolean cancel()
Отменяет любую текущую выполняющуюся задачу, если она есть. Состояние будет установлено в CANCELLED.
-
restart
public void restart()
Отменяет любую текущую выполняющуюся задачу, если она есть, и перезапускает эту службу. Состояние будет сброшено в READY перед выполнением. Этот метод должен вызываться только в потоке FX-приложения.
-
reset
public void reset()
Сбрасывает состояние службы. Может быть вызван только в одном из конечных состояний, то есть SUCCEEDED, FAILED или CANCELLED, или когда READY. Этот метод должен вызываться только в потоке FX-приложения.
-
start
public void start()
Запускает эту службу. Служба должна быть в состоянии READY, чтобы этот вызов был успешным. Этот метод должен вызываться только в потоке FX-приложения.
-
executeTask
protected void executeTask(Task<V> task)
Использует
executor, определённый в этой службе, для выполнения заданной задачи. Еслиexecutorравно null, то используется исполняющий механизм по умолчанию, который создаст новый демон-поток для выполнения этой задачи.Этот метод предназначен только для вызова реализацией службы.
Параметры:
task- непустая задача для выполненияС момента:
JavaFX 2.1
-
addEventHandler
public final <T extends Event> void addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)Регистрирует обработчик событий в этой задаче. Сначала обрабатываются любые фильтры событий, затем указанные обработчики событий onFoo, а затем любые обработчики событий, зарегистрированные этим методом. Как и в случае с другими событиями в графическом представлении сцены, если событие потребляется, оно не будет продолжать распространение.Параметры типа:
T- конкретный класс событий обработчикаПараметры:
eventType- тип событий, которые должен получать обработчикИсключения:
NullPointerException- если тип события или обработчик равны nullС момента:
JavaFX 2.1
-
removeEventHandler
public final <T extends Event> void removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)Удаляет ранее зарегистрированный обработчик событий из этой задачи. Один обработчик может быть зарегистрирован для разных типов событий, поэтому вызывающая сторона должна указать конкретный тип события, из которого нужно удалить обработчик.Параметры типа:
T- конкретный класс событий обработчикаПараметры:
eventType- тип события, из которого нужно удалить обработчикИсключения:
NullPointerException- если тип события или обработчик равны nullС момента:
JavaFX 2.1
-
addEventFilter
public final <T extends Event> void addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)Регистрирует фильтр событий в этой задаче. Зарегистрированные фильтры событий получают событие до любого связанного обработчика событий.Параметры типа:
T- конкретный класс событий фильтраПараметры:
eventType- тип событий, которые должен получать фильтрИсключения:
NullPointerException- если тип события или фильтр равны nullС момента:
JavaFX 2.1
-
-
removeEventFilter
public final <T extends Event> void removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)Отменяет регистрацию ранее зарегистрированного фильтра событий для этой задачи. Один фильтр может быть зарегистрирован для разных типов событий, поэтому вызывающий код должен указать конкретный тип события, из которого нужно снять регистрацию фильтра.Type Parameters:
T- конкретный класс события фильтраParameters:
eventType- тип события, из которого нужно снять регистрациюThrows:
NullPointerException- если тип события или фильтр равен nullSince:
JavaFX 2.1
-
setEventHandler
protected final <T extends Event> void setEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)Устанавливает обработчик для этого типа события. Одновременно можно указать только один такой обработчик. Этот обработчик гарантированно вызывается первым. Используется для регистрации пользовательских обработчиков событий onFoo.Type Parameters:
T- конкретный класс события обработчикаParameters:
eventType- тип события, который нужно связать с данным eventHandlerThrows:
NullPointerException- если тип события равен nullSince:
JavaFX 2.1
-
fireEvent
protected final void fireEvent(Event event)
Возбуждает указанное событие. Любой встреченный фильтр событий будет уведомлён и сможет потреблять событие. Если событие не будет потреблено фильтрами, будут уведомлены обработчики событий в этой задаче. Если и они не потребят событие, то будут вызваны все обработчики событий и смогут потреблять событие.Этот метод должен вызываться в потоке FX пользователя.
Parameters:
event- событие для возбужденияSince:
JavaFX 2.1
-
buildEventDispatchChain
public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)
Описание скопировано из интерфейса:EventTargetСоздаёт цепочку обработки событий для этого целевого объекта. Цепочка обработки событий содержит диспетчеры событий, которые могут быть заинтересованы в обработке событий, направленных на этотEventTarget. Этот целевой объект событий не добавляется в цепочку автоматически, поэтому, если он хочет обрабатывать события, ему нужно добавить свойEventDispatcherв цепочку.В случае, если целевой объект событий является частью иерархии, цепочка для него обычно строится из диспетчеров событий, собранных от корня иерархии до целевого объекта событий.
Цепочка обработки событий строится путём модификации предоставленной начальной цепочки обработки событий. Возвращаемая цепочка должна содержать начальную цепочку в конце, поэтому диспетчеры должны быть добавлены перед начальной цепочкой.
Вызывающий код не должен предполагать, что начальная цепочка останется неизменной, а также, что возвращаемое значение будет ссылаться на другую цепочку.
Specified by:
buildEventDispatchChainв интерфейсеEventTargetParameters:
tail- начальная цепочка для построенияReturns:
результирующая цепочка обработки событий для этого целевого объекта
-
createTask
protected abstract Task<V> createTask()
Вызывается после запуска службы в потоке JavaFX Application. Реализации должны сохранить любые состояния в постоянные переменные перед созданием задачи, так как доступ к свойствам службы внутри кода задачи в фоновом потоке приведет к исключениям. Например: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; } } }Если задача является предопределенным классом (в отличие от анонимного класса) и если она следует рекомендуемой лучшей практике, то сохранять состояние перед построением задачи нет необходимости, так как её состояние полностью предоставляется в её конструкторе.
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()); }Returns:
задача для выполнения
-
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.