edu.rice.cs.util.swing
Class SwingWorker

java.lang.Object
  edu.rice.cs.util.swing.SwingWorker

public abstract class SwingWorker
extends Object

SwingWorker, adapted from Sun's Java Tutorial. 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.

Version:

$Id: SwingWorker.java 5175 2010-01-20 08:46:32Z mgricken $

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 Object	_value

Constructor Summary

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

Method Summary

abstract Object	construct() Compute the value to be returned by the get method.
void	finished() Called from the event dispatching thread (not on the worker thread) after the construct method has returned.
Object	get() Return the value created by the construct method.
protected Object	getValue() Gets 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(Object x) Sets 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

_value

private volatile Object _value

_threadVar

private volatile SwingWorker.ThreadVar _threadVar

Constructor Detail

SwingWorker

public SwingWorker()

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

Method Detail

getValue

protected Object getValue()

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

setValue

private void setValue(Object x)

Sets the value produced by worker thread.

construct

public abstract Object construct()

Compute the value to be returned by the get method.

finished

public void finished()

Called from 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 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.