javax.swing

Класс SwingWorker <T, V>

java.lang. Объект

javax.swing. SwingWorker <T, V>

Введите Параметры:

T - тип результата возвратился этим SwingWorker's doInBackground и get методы

V - тип, используемый для того, чтобы выполнить промежуточное звено, заканчивается этим SwingWorker's publish и process методы

Все Реализованные Интерфейсы:

Выполнимый, Будущее <T>, RunnableFuture <T>

public abstract class SwingWorker<T,V>
extends Object
implements RunnableFuture<T>

Абстрактный класс, чтобы выполнить длинные задачи взаимодействия GUI в фоновом потоке. Несколько фоновых потоков могут использоваться, чтобы выполнить такие задачи. Однако, точная стратегия выбора потока для любой детали SwingWorker является неуказанным и не должен быть положен.

При записи многопоточного приложения, используя Swing, есть два ограничения, чтобы иметь в виду: (обратитесь к тому, Как Использовать Потоки для большего количества деталей):

• На отнимающих много времени задачах нельзя работать, Событие Диспетчеризирует Поток. Иначе приложение становится безразличным.
• К компонентам Swing нужно получить доступ на Событии, Диспетчеризируют Поток только.

Эти ограничения означают что приложение GUI со временем интенсивные вычислительные потребности по крайней мере два потока: 1) поток, чтобы выполнить длинную задачу и 2) Событие Диспетчеризирует Поток (EDT) для всех связанных с GUI действий. Это включает передачу межпотока, которая может быть хитрой, чтобы реализовать.

SwingWorker разрабатывается для ситуаций, где Вам нужно было выполнить длинную выполняющуюся задачу в фоновом потоке и обеспечить обновления для UI или когда сделано, или обрабатывая. Подклассы SwingWorker должен реализовать doInBackground() метод, чтобы выполнить фоновое вычисление.

Поток операций

Есть три потока, включенные в жизненный цикл a SwingWorker :

• Текущий поток: execute() метод вызывают на этом потоке. Это планирует SwingWorker для выполнения на рабочем потоке и возвратов сразу. Можно ожидать SwingWorker завершать использование get методы.

• Рабочий поток: doInBackground() метод вызывают на этом потоке. Это - то, где все фоновые действия должны произойти. Уведомлять PropertyChangeListeners о связанных свойствах изменения используют firePropertyChange и getPropertyChangeSupport() методы. По умолчанию есть два связанных доступные свойства: state и progress.

• Событие Диспетчеризирует Поток: Весь Swing связанные действия происходит на этом потоке. SwingWorker вызывает process и done() методы и уведомляют любого PropertyChangeListeners на этом потоке.

Часто, Текущий поток является Событием, Диспетчеризируют Поток.

Перед doInBackground метод вызывается на рабочий поток, SwingWorker уведомляет любого PropertyChangeListeners о state изменение свойства к StateValue.STARTED. После doInBackground метод заканчивается done метод выполняется. Затем SwingWorker уведомляет любого PropertyChangeListeners о state изменение свойства к StateValue.DONE.

SwingWorker только разрабатывается, чтобы быть выполненным однажды. Выполнение a SwingWorker не раз не будет приводить к вызову doInBackground метод дважды.

Демонстрационное Использование

Следующий пример иллюстрирует самый простой вариант использования. Некоторая обработка делается в фоновом режиме, и когда сделано Вы обновляете компонент Swing.

Скажите, что мы хотим найти "Значение Жизни" и вывести на экран результат в a JLabel.

   final JLabel label;
   class MeaningOfLifeFinder extends SwingWorker<String, Object> {
       @Override
       public String doInBackground() {
           return findTheMeaningOfLife();
       }

       @Override
       protected void done() {
           try {
               label.setText(get());
           } catch (Exception ignore) {
           }
       }
   }

   (new MeaningOfLifeFinder()).execute();
 

Следующий пример полезен в ситуациях, где Вы хотите обработать данные, поскольку это готово на Событии, Диспетчеризируют Поток.

Теперь мы хотим найти первые простые числа N и вывести на экран результаты в a JTextArea. В то время как это является вычислительным, мы хотим обновить наше продвижение a JProgressBar. Наконец, мы также хотим напечатать простые числа к System.out.

 class PrimeNumbersTask extends
         SwingWorker<List<Integer>, Integer> {
     PrimeNumbersTask(JTextArea textArea, int numbersToFind) {
         //initialize
     }

     @Override
     public List<Integer> doInBackground() {
         while (! enough && ! isCancelled()) {
                 number = nextPrimeNumber();
                 publish(number);
                 setProgress(100 * numbers.size() / numbersToFind);
             }
         }
         return numbers;
     }

     @Override
     protected void process(List<Integer> chunks) {
         for (int number : chunks) {
             textArea.append(number + "\n");
         }
     }
 }

 JTextArea textArea = new JTextArea();
 final JProgressBar progressBar = new JProgressBar(0, 100);
 PrimeNumbersTask task = new PrimeNumbersTask(textArea, N);
 task.addPropertyChangeListener(
     new PropertyChangeListener() {
         public  void propertyChange(PropertyChangeEvent evt) {
             if ("progress".equals(evt.getPropertyName())) {
                 progressBar.setValue((Integer)evt.getNewValue());
             }
         }
     });

 task.execute();
 System.out.println(task.get()); //prints all prime numbers we have got
 

Поскольку SwingWorker реализации Runnable, a SwingWorker может быть представлен Executor для выполнения.

С тех пор:

1.6

Вложенная Сводка Класса

Вложенные Классы

Модификатор и Тип	Класс и Описание
static class	SwingWorker. StateValue Значения для state связанное свойство.

Сводка конструктора

Конструкторы

Конструктор и Описание
SwingWorker() Конструкции это SwingWorker.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
void	addPropertyChangeListener(PropertyChangeListener listener) Добавляет a PropertyChangeListener к списку слушателя.
boolean	cancel(boolean mayInterruptIfRunning) Попытки отменить выполнение этой задачи.
protected abstract T	doInBackground() Вычисляет результат, или выдает исключение если неспособный, чтобы сделать так.
protected void	done() Выполняемый на Событии Диспетчеризируют Поток после doInBackground метод заканчивается.
void	execute() Расписания это SwingWorker для выполнения на рабочем потоке.
void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Сообщает связанное обновление свойства любым зарегистрированным слушателям.
T	get() Ожидает в случае необходимости вычисления, чтобы завершиться, и затем получает его результат.
T	get(long timeout, TimeUnit unit) Ожидает в случае необходимости в течение самое большее данного времени для вычисления, чтобы завершиться, и затем получает его результат, при наличии.
int	getProgress() Возвраты progress связанное свойство.
PropertyChangeSupport	getPropertyChangeSupport() Возвраты PropertyChangeSupport для этого SwingWorker.
SwingWorker. StateValue	getState() Возвраты SwingWorker утвердите связанное свойство.
boolean	isCancelled() true возвратов, если эта задача была отменена прежде, чем это обычно завершалось.
boolean	isDone() true возвратов, если эта задача завершалась.
protected void	process(List<V> chunks) Получает блоки данных из publish метод асинхронно на Событии Диспетчеризирует Поток.
protected void	publish(V... chunks) Отправляет блоки данных process(java.util.List<V>) метод.
void	removePropertyChangeListener(PropertyChangeListener listener) Удаляет a PropertyChangeListener от списка слушателя.
void	run() Наборы это Future к результату вычисления, если это не было отменено.
protected void	setProgress(int progress) Наборы progress связанное свойство.

Методы java.lang унаследованный от класса. Объект

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

Деталь конструктора

SwingWorker

public SwingWorker()

Конструкции это SwingWorker.

Деталь метода

doInBackground

protected abstract T doInBackground()
                             throws Exception

Вычисляет результат, или выдает исключение если неспособный, чтобы сделать так.

Отметьте, что этот метод выполняется только однажды.

Отметьте: этот метод выполняется в фоновом потоке.

Возвраты:

вычисленный результат

Броски:

Exception - если неспособный вычислить результат

выполненный

public final void run()

Наборы это Future к результату вычисления, если это не было отменено.

Определенный:

run в интерфейсе Runnable

Определенный:

run в интерфейсе RunnableFuture<T>

См. Также:

Thread.run()

опубликовать

@SafeVarargs
protected final void publish(V... chunks)

Отправляет блоки данных process(java.util.List<V>) метод. Этот метод должен использоваться изнутри doInBackground метод, чтобы поставить промежуточные результаты для того, чтобы обработать на Событии Диспетчеризирует Поток в process метод.

Поскольку process метод вызывается асинхронно на Событии, Диспетчеризируют Поток многократные вызовы publish метод мог бы произойти перед process метод выполняется. В целях производительности все эти вызовы объединяются в один вызов со связанными параметрами.

Например:

 publish("1");
 publish("2", "3");
 publish("4", "5", "6");
 

мог бы привести к:

 process("1", "2", "3", "4", "5", "6")
 

Демонстрационное Использование. Этот фрагмент кода загружает некоторые табличные данные и обновления DefaultTableModel с этим. Отметьте что это безопасный видоизменить tableModel изнутри process метод, потому что это вызывается на Событие, Диспетчеризирует Поток.

 class TableSwingWorker extends
         SwingWorker<DefaultTableModel, Object[]> {
     private final DefaultTableModel tableModel;

     public TableSwingWorker(DefaultTableModel tableModel) {
         this.tableModel = tableModel;
     }

     @Override
     protected DefaultTableModel doInBackground() throws Exception {
         for (Object[] row = loadData();
                  ! isCancelled() && row != null;
                  row = loadData()) {
             publish((Object[]) row);
         }
         return tableModel;
     }

     @Override
     protected void process(List<Object[]> chunks) {
         for (Object[] row : chunks) {
             tableModel.addRow(row);
         }
     }
 }
 

Параметры:

chunks - промежуточное звено заканчивается, чтобы обработать

См. Также:

process(java.util.List<V>)

процесс

protected void process(List<V> chunks)

Получает блоки данных из publish метод асинхронно на Событии Диспетчеризирует Поток.

Пожалуйста, обратитесь к publish(V...) метод для большего количества деталей.

Параметры:

chunks - промежуточное звено заканчивается, чтобы обработать

См. Также:

publish(V...)

сделанный

protected void done()

Выполняемый на Событии Диспетчеризируют Поток после doInBackground метод заканчивается. Реализация по умолчанию ничего не делает. Подклассы могут переопределить этот метод, чтобы выполнить действия завершения на Событии, Диспетчеризируют Поток. Отметьте, что можно запросить состояние в реализации этого метода, чтобы определить результат этой задачи или была ли эта задача отменена.

См. Также:

doInBackground(), isCancelled(), get()

setProgress

protected final void setProgress(int progress)

Наборы progress связанное свойство. Значение должно быть от 0 до 100.

Поскольку PropertyChangeListeners уведомляются асинхронно на Событии, Диспетчеризируют Поток многократные вызовы setProgress метод мог бы произойти перед любым PropertyChangeListeners вызываются. В целях производительности все эти вызовы объединяются в один вызов с последним параметром вызова только.

Например, следующий invokations:

 setProgress(1);
 setProgress(2);
 setProgress(3);
 

мог бы привести к синглу PropertyChangeListener уведомление со значением 3.

Параметры:

progress - значение продвижения, чтобы установить

Броски:

IllegalArgumentException - значение не от 0 до 100

getProgress

public final int getProgress()

Возвраты progress связанное свойство.

Возвраты:

продвижение связанное свойство.

выполниться

public final void execute()

Расписания это SwingWorker для выполнения на рабочем потоке. Есть много доступных рабочих потоков. В конечном счете все рабочие потоки заняты, обрабатывая другой SwingWorkers это SwingWorker помещается в ожидающую очередь.

Отметьте: SwingWorker только разрабатывается, чтобы быть выполненным однажды. Выполнение a SwingWorker не раз не будет приводить к вызову doInBackground метод дважды.

отмена

public final boolean cancel(boolean mayInterruptIfRunning)

Попытки отменить выполнение этой задачи. Эта попытка перестанет работать, если задача уже завершилась, была уже отменена, или не могла бы быть отменена по некоторой другой причине. В случае успеха, и эта задача не запустилась, когда cancel вызывают, эта задача никогда не должна работать. Если задача уже запустилась, то параметр mayInterruptIfRunning определяет, должен ли поток, выполняющий эту задачу, быть прерван в попытке остановить задачу.

После этого метода возвраты, последующие звонки Future.isDone() будет всегда возвращать true. Последующие звонки Future.isCancelled() будет всегда возвращать true если этот метод возвращенный true.

Определенный:

cancel в интерфейсе Future<T>

Параметры:

mayInterruptIfRunning - true, если поток, выполняющий эту задачу, должен быть прерван; иначе, происходящим задачам позволяют завершиться

Возвраты:

false, если задача не могла бы быть отменена, обычно потому что это уже обычно завершалось; true иначе

isCancelled

public final boolean isCancelled()

true возвратов, если эта задача была отменена прежде, чем это обычно завершалось.

Определенный:

isCancelled в интерфейсе Future<T>

Возвраты:

true, если эта задача была отменена прежде, чем это завершалось

isDone

public final boolean isDone()

true возвратов, если эта задача завершалась. Завершение может произойти из-за нормального завершения, исключения, или отмены - во всех этих случаях, этот метод возвратит true.

Определенный:

isDone в интерфейсе Future<T>

Возвраты:

true, если эта задача завершалась

добраться

public final T get()
            throws InterruptedException,
                   ExecutionException

Ожидает в случае необходимости вычисления, чтобы завершиться, и затем получает его результат.

Отметьте: вызов get на Событии Диспетчеризируют блоки Потока все события, включая перекрашивания, от того, чтобы быть обработанным до этого SwingWorker полно.

Когда Вы хотите SwingWorker чтобы блокировать на Событии Диспетчеризируют Поток, мы рекомендуем, чтобы Вы использовали модальное диалоговое окно.

Например:

 class SwingWorkerCompletionWaiter extends PropertyChangeListener {
     private JDialog dialog;

     public SwingWorkerCompletionWaiter(JDialog dialog) {
         this.dialog = dialog;
     }

     public void propertyChange(PropertyChangeEvent event) {
         if ("state".equals(event.getPropertyName())
                 && SwingWorker.StateValue.DONE == event.getNewValue()) {
             dialog.setVisible(false);
             dialog.dispose();
         }
     }
 }
 JDialog dialog = new JDialog(owner, true);
 swingWorker.addPropertyChangeListener(
     new SwingWorkerCompletionWaiter(dialog));
 swingWorker.execute();
 //the dialog will be visible until the SwingWorker is done
 dialog.setVisible(true);
 

Определенный:

get в интерфейсе Future<T>

Возвраты:

вычисленный результат

Броски:

InterruptedException - если текущий поток был прерван, ожидая

ExecutionException - если вычисление выдавало исключение

добраться

public final T get(long timeout,
    TimeUnit unit)
            throws InterruptedException,
                   ExecutionException,
                   TimeoutException

Ожидает в случае необходимости в течение самое большее данного времени для вычисления, чтобы завершиться, и затем получает его результат, при наличии.

Пожалуйста, обратитесь к get() для большего количества деталей.

Определенный:

get в интерфейсе Future<T>

Параметры:

timeout - максимальное время, чтобы ожидать

unit - единица измерения времени параметра тайм-аута

Возвраты:

вычисленный результат

Броски:

InterruptedException - если текущий поток был прерван, ожидая

ExecutionException - если вычисление выдавало исключение

TimeoutException - если ожидание синхронизированного

addPropertyChangeListener

public final void addPropertyChangeListener(PropertyChangeListener listener)

Добавляет a PropertyChangeListener к списку слушателя. Слушатель регистрируется для всех свойств. Тот же самый объект слушателя может быть добавлен не раз, и будет вызван так много раз, как он добавляется. Если listener null, никакое исключение не выдается, и никакие меры не предпринимаются.

Отметьте: Это - просто обертка удобства. Вся работа делегируется к PropertyChangeSupport от getPropertyChangeSupport().

Параметры:

listener - PropertyChangeListener быть добавленным

removePropertyChangeListener

public final void removePropertyChangeListener(PropertyChangeListener listener)

Удаляет a PropertyChangeListener от списка слушателя. Это удаляет a PropertyChangeListener это было зарегистрировано для всех свойств. Если listener был добавлен не раз к тому же самому источнику события, он будет уведомлен один меньше времени, будучи удаленным. Если listener null, или никогда не добавлялся, никакое исключение не выдается, и никакие меры не предпринимаются.

Отметьте: Это - просто обертка удобства. Вся работа делегируется к PropertyChangeSupport от getPropertyChangeSupport().

Параметры:

listener - PropertyChangeListener быть удаленным

firePropertyChange

public final void firePropertyChange(String propertyName,
                      Object oldValue,
                      Object newValue)

Сообщает связанное обновление свойства любым зарегистрированным слушателям. Никакое событие не запускается если old и new являются равными и ненулевыми.

Это SwingWorker будет источник для любых сгенерированных событий.

Когда отозвано Событие Диспетчеризирует Поток PropertyChangeListeners уведомляются асинхронно на Событии, Диспетчеризируют Поток.

Отметьте: Это - просто обертка удобства. Вся работа делегируется к PropertyChangeSupport от getPropertyChangeSupport().

Параметры:

propertyName - программируемое имя свойства, которое было изменено

oldValue - старое значение свойства

newValue - новое значение свойства

getPropertyChangeSupport

public final PropertyChangeSupport getPropertyChangeSupport()

Возвраты PropertyChangeSupport для этого SwingWorker. Этот метод используется, когда гибкий доступ к связанной поддержке свойств необходим.

Это SwingWorker будет источник для любых сгенерированных событий.

Отметьте: возвращенный PropertyChangeSupport уведомляет любого PropertyChangeListeners асинхронно на Событии Диспетчеризируют Поток когда firePropertyChange или fireIndexedPropertyChange отзываются Событие Диспетчеризирует Поток.

Возвраты:

PropertyChangeSupport для этого SwingWorker

getState

public final SwingWorker.StateValue getState()

Возвраты SwingWorker утвердите связанное свойство.

Возвраты:

текущее состояние