com.taco.swinger
Class SwingWorker

java.lang.Object
  extended by com.taco.swinger.SwingWorker

public abstract class SwingWorker
extends java.lang.Object

This is the 3rd version of SwingWorker (also known as SwingWorker 3), an abstract class that you subclass to perform GUI-related work in a dedicated thread. For instructions on using this class, see: http://java.sun.com/docs/books/tutorial/uiswing/misc/threads.html Note that the API changed slightly in the 3rd version: You must now invoke start() on the SwingWorker after creating it.


Field Summary
protected  java.lang.Object _data
          An object that may be used to indicate a change of state for the worker thread.
 
Constructor Summary
SwingWorker()
          Start a thread that will call the construct method and then exit.
 
Method Summary
abstract  java.lang.Object construct()
          Compute the value to be returned by the get method.
 void finished()
          Called on the event dispatching thread (not on the worker thread) after the construct method has returned.
 java.lang.Object get()
          Return the value created by the construct method.
 java.lang.Object getData()
          Used to retrieve any data that should be passed to the worker thread.
 java.lang.Object getValue()
          Get the value produced by the worker thread, or null if it hasn't been constructed yet.
 void interrupt()
          A new method that interrupts the worker thread.
 java.lang.Object runInEventDispatchingThread()
          Execute the construct() and finished() methods in the current thread, which should be the event dispatching thread.
 void setData(java.lang.Object obj)
          Used to set any data that should be passed to the worker thread.
 void setPriority(int priority)
          Set the thread priority if it exists.
protected  void setValue(java.lang.Object x)
          Set the value produced by worker thread
 void start()
          Start the worker thread.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_data

protected java.lang.Object _data
An object that may be used to indicate a change of state for the worker thread.

Constructor Detail

SwingWorker

public SwingWorker()
Start a thread that will call the construct method and then exit.

Method Detail

getValue

public java.lang.Object getValue()
Get the value produced by the worker thread, or null if it hasn't been constructed yet.


setValue

protected void setValue(java.lang.Object x)
Set the value produced by worker thread


getData

public java.lang.Object getData()
Used to retrieve any data that should be passed to the worker thread. If the data has not been set yet, it will be null.


setData

public void setData(java.lang.Object obj)
Used to set any data that should be passed to the worker thread.


construct

public abstract java.lang.Object construct()
Compute the value to be returned by the get method.


finished

public void finished()
Called on the event dispatching thread (not on the worker thread) after the construct method has returned.


interrupt

public void interrupt()
A new method that interrupts the worker thread. Call this method to force the worker to stop what it's doing.


get

public java.lang.Object get()
Return the value created by the construct method. Returns null if either the constructing thread or the current thread was interrupted before a value was produced.

Returns:
the value created by the construct method

start

public void start()
Start the worker thread.


setPriority

public void setPriority(int priority)
Set the thread priority if it exists.


runInEventDispatchingThread

public java.lang.Object runInEventDispatchingThread()
Execute the construct() and finished() methods in the current thread, which should be the event dispatching thread. Return the value that the construct() method returned. This can be used instead of start() if the caller needs to wait for the operation to complete right away.