org.opencyc.util
Class SwingWorker
java.lang.Object
|
+--org.opencyc.util.SwingWorker
- Direct Known Subclasses:
- CycWorker
- 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.
Note: tbrussea added an event callback wrapper class based
on this one, called CycWorker that should be easier to use.
THIS SOFTWARE AND KNOWLEDGE BASE CONTENT ARE PROVIDED ``AS IS'' AND
ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OPENCYC
ORGANIZATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE AND KNOWLEDGE
BASE CONTENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Inner Class Summary |
static class |
SwingWorker.ThreadVar
Class to maintain reference to current worker thread
under separate synchronization control. |
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. |
protected 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. |
void |
start()
Start the worker thread. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
threadVar
protected SwingWorker.ThreadVar threadVar
SwingWorker
public SwingWorker()
- Start a thread that will call the
construct
method
and then exit.
getValue
protected java.lang.Object getValue()
- Get the value produced by the worker thread, or null if it
hasn't been constructed yet.
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.