T
- the result type returned by this SwingWorker's
doInBackground
and get
methodsV
- the type used for carrying out intermediate results by this
SwingWorker's
publish
and process
methodspublic abstract class SwingWorker<T,V>
extends java.lang.Object
implements java.util.concurrent.Future<T>, java.lang.Runnable
Modifier and Type | Class and Description |
---|---|
static class |
SwingWorker.StateValue
Deprecated.
Values for the
state bound property. |
Constructor and Description |
---|
SwingWorker()
Deprecated.
Constructs this
SwingWorker . |
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Deprecated.
Adds a
PropertyChangeListener to the listener list. |
boolean |
cancel(boolean mayInterruptIfRunning)
Deprecated.
|
protected abstract T |
doInBackground()
Deprecated.
Computes a result, or throws an exception if unable to do so.
|
protected void |
done()
Deprecated.
Executed on the Event Dispatch Thread after the
doInBackground
method is finished. |
void |
execute()
Deprecated.
Schedules this
SwingWorker for execution on a worker
thread. |
void |
firePropertyChange(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
Deprecated.
Reports a bound property update to any registered listeners.
|
T |
get()
Deprecated.
|
T |
get(long timeout,
java.util.concurrent.TimeUnit unit)
Deprecated.
|
int |
getProgress()
Deprecated.
Returns the
progress bound property. |
java.beans.PropertyChangeSupport |
getPropertyChangeSupport()
Deprecated.
Returns the
PropertyChangeSupport for this SwingWorker . |
SwingWorker.StateValue |
getState()
Deprecated.
Returns the
SwingWorker state bound property. |
boolean |
isCancelled()
Deprecated.
|
boolean |
isDone()
Deprecated.
|
protected void |
process(java.util.List<V> chunks)
Deprecated.
Receives data chunks from the
publish method asynchronously on the
Event Dispatch Thread. |
protected void |
publish(V... chunks)
Deprecated.
Sends data chunks to the
process(java.util.List<V>) method. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Deprecated.
Removes a
PropertyChangeListener from the listener list. |
void |
run()
Deprecated.
Sets this
Future to the result of computation unless
it has been canceled. |
protected void |
setProgress(int progress)
Deprecated.
Sets the
progress bound property. |
protected abstract T doInBackground() throws java.lang.Exception
Note that this method is executed only once.
Note: this method is executed in a background thread.
java.lang.Exception
- if unable to compute a resultpublic final void run()
Future
to the result of computation unless
it has been canceled.run
in interface java.lang.Runnable
protected final void publish(V... chunks)
process(java.util.List<V>)
method. This method is to be
used from inside the doInBackground
method to deliver
intermediate results
for processing on the Event Dispatch Thread inside the
process
method.
Because the process
method is invoked asynchronously on
the Event Dispatch Thread
multiple invocations to the publish
method
might occur before the process
method is executed. For
performance purposes all these invocations are coalesced into one
invocation with concatenated arguments.
For example:
publish("1"); publish("2", "3"); publish("4", "5", "6");might result in:
process("1", "2", "3", "4", "5", "6")
Sample Usage. This code snippet loads some tabular data and
updates DefaultTableModel
with it. Note that it safe to mutate
the tableModel from inside the process
method because it is
invoked on the Event Dispatch Thread.
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
- intermediate results to processprocess(java.util.List<V>)
protected void process(java.util.List<V> chunks)
publish
method asynchronously on the
Event Dispatch Thread.
Please refer to the publish(V...)
method for more details.
chunks
- intermediate results to processpublish(V...)
protected void done()
doInBackground
method is finished. The default
implementation does nothing. Subclasses may override this method to
perform completion actions on the Event Dispatch Thread. Note
that you can query status inside the implementation of this method to
determine the result of this task or whether this task has been canceled.doInBackground()
,
isCancelled()
,
get()
protected final void setProgress(int progress)
progress
bound property.
The value should be from 0 to 100.
Because PropertyChangeListener
s are notified asynchronously on
the Event Dispatch Thread multiple invocations to the
setProgress
method might occur before any
PropertyChangeListeners
are invoked. For performance purposes
all these invocations are coalesced into one invocation with the last
invocation argument only.
For example, the following invocations:
setProgress(1); setProgress(2); setProgress(3);might result in a single
PropertyChangeListener
notification with
the value 3
.progress
- the progress value to setjava.lang.IllegalArgumentException
- is value not from 0 to 100public final int getProgress()
progress
bound property.public final void execute()
SwingWorker
for execution on a worker
thread. There are a number of worker threads available. In the
event all worker threads are busy handling other
SwingWorkers
this SwingWorker
is placed in a waiting
queue.
Note:
SwingWorker
is only designed to be executed once. Executing a
SwingWorker
more than once will not result in invoking the
doInBackground
method twice.
public boolean cancel(boolean mayInterruptIfRunning)
cancel
in interface java.util.concurrent.Future<T>
public final boolean isCancelled()
isCancelled
in interface java.util.concurrent.Future<T>
public final boolean isDone()
isDone
in interface java.util.concurrent.Future<T>
public final T get() throws java.lang.InterruptedException, java.util.concurrent.ExecutionException
Note: calling get
on the Event Dispatch Thread blocks
all events, including repaints, from being processed until this
SwingWorker
is complete.
When you want the SwingWorker
to block on the Event
Dispatch Thread we recommend that you use a modal dialog.
For example:
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
in interface java.util.concurrent.Future<T>
java.lang.InterruptedException
java.util.concurrent.ExecutionException
public final T get(long timeout, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException, java.util.concurrent.ExecutionException, java.util.concurrent.TimeoutException
Please refer to get()
for more details.
get
in interface java.util.concurrent.Future<T>
java.lang.InterruptedException
java.util.concurrent.ExecutionException
java.util.concurrent.TimeoutException
public final void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeListener
to the listener list. The listener
is registered for all properties. The same listener object may be added
more than once, and will be called as many times as it is added. If
listener
is null
, no exception is thrown and no action is taken.
Note: This is merely a convenience wrapper. All work is delegated to
PropertyChangeSupport
from getPropertyChangeSupport()
.
listener
- the PropertyChangeListener
to be addedpublic final void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeListener
from the listener list. This
removes a PropertyChangeListener
that was registered for all
properties. If listener
was added more than once to the same
event source, it will be notified one less time after being removed. If
listener
is null
, or was never added, no exception is
thrown and no action is taken.
Note: This is merely a convenience wrapper. All work is delegated to
PropertyChangeSupport
from getPropertyChangeSupport()
.
listener
- the PropertyChangeListener
to be removedpublic final void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
old
and new
are equal and non-null.
This SwingWorker
will be the source for
any generated events.
When called off the Event Dispatch Thread
PropertyChangeListeners
are notified asynchronously on
the Event Dispatch Thread.
Note: This is merely a convenience wrapper. All work is delegated to
PropertyChangeSupport
from getPropertyChangeSupport()
.
propertyName
- the programmatic name of the property that was
changedoldValue
- the old value of the propertynewValue
- the new value of the propertypublic final java.beans.PropertyChangeSupport getPropertyChangeSupport()
PropertyChangeSupport
for this SwingWorker
.
This method is used when flexible access to bound properties support is
needed.
This SwingWorker
will be the source for
any generated events.
Note: The returned PropertyChangeSupport
notifies any
PropertyChangeListener
s asynchronously on the Event Dispatch
Thread in the event that firePropertyChange
or
fireIndexedPropertyChange
are called off the Event Dispatch
Thread.
PropertyChangeSupport
for this SwingWorker
public final SwingWorker.StateValue getState()
SwingWorker
state bound property.