ptolemy.gui
Class SwingWorker

java.lang.Object
  ptolemy.gui.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.

Since:

Ptolemy II 2.0

Version:

$Id: SwingWorker.java 39592 2005-10-24 19:09:12Z cxh $

Author:

Sun Microsystems

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Nested Class Summary

private static class

SwingWorker.ThreadVar Class to maintain reference to current worker thread under separate synchronization control.

Field Summary

private SwingWorker.ThreadVar	_threadVar
private java.lang.Object	_value

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.
private void	setValue(java.lang.Object object) 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

_threadVar

private SwingWorker.ThreadVar _threadVar

_value

private java.lang.Object _value

Constructor Detail

SwingWorker

public SwingWorker()

Start a thread that will call the construct method and then exit.

Method Detail

construct

public abstract java.lang.Object construct()

Compute the value to be returned by the get method.

Returns:

The object that is created by the construct() method in a subclass.

finished

public void finished()

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

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

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.

start

public void start()

Start the worker thread.

getValue

protected java.lang.Object getValue()

Get the value produced by the worker thread, or null if it hasn't been constructed yet.

Returns:

the value.

setValue

private void setValue(java.lang.Object object)

Set the value produced by worker thread