SwingWorker

This article has multiple issues. Please help improve it or discuss these issues on the talk page. (Learn how and when to remove these messages) This article relies excessively on references to primary sources. Please improve this article by adding secondary or tertiary sources. Find sources: "SwingWorker" – news · newspapers · books · scholar · JSTOR (June 2012) (Learn how and when to remove this message) This article needs additional citations for verification. Please help improve this article by adding citations to reliable sources. Unsourced material may be challenged and removed. Find sources: "SwingWorker" – news · newspapers · books · scholar · JSTOR (June 2012) (Learn how and when to remove this message) This article contains instructions, advice, or how-to content. Please help rewrite the content so that it is more encyclopedic or move it to Wikiversity, Wikibooks, or Wikivoyage. (April 2011) (Learn how and when to remove this message)

SwingWorker is a utility class developed by Sun Microsystems for the Swing library of the Java programming language. SwingWorker enables proper use of the event dispatching thread. As of Java 6, SwingWorker is included in the JRE.^[1]

Several incompatible, unofficial, versions of SwingWorker were produced from 1998 to 2006, and care must be taken to avoid the abundant documentation on these versions predating Java 6.

SwingWorker is useful when a time-consuming task has to be performed following a user-interaction event (for example, parsing a huge XML File, on pressing a JButton). The most straightforward way to do it is :

private Document doc; ... JButton button = new JButton("Open XML"); button.addActionListener(new ActionListener() {     @Override     public void actionPerformed(ActionEvent e) {         doc = loadXML();     } }); 

This will work, but unfortunately, the loadXML() method will be called in the same thread as the main Swing thread (the Event dispatching thread), so if the method needs time to perform, the GUI will freeze during this time.

This problem is not specific to Java, but common to many GUI models. SwingWorker proposes a way to solve it by performing the time-consuming task on another background thread, keeping the GUI responsive during this time.

The following code defines the SwingWorker, which encapsulates the loadXML() method call :

SwingWorker worker = new SwingWorker<Document, Void>() {     @Override     public Document doInBackground() {         Document intDoc = loadXML();         return intDoc;     } }; 

Execution is started by using the SwingWorker.execute() method.

The result can be retrieved by using the SwingWorker.get() method.

As calling get() on the Event Dispatch Thread blocks all events, including repaints, from being processed until the task completes, one must avoid calling it before the lengthy operation has finished. There are two ways to retrieve the result after the task completion :

• override the SwingWorker.done() method. This method is called on the main event dispatching thread.

private Document doc; ... SwingWorker<Document, Void> worker = new SwingWorker<Document, Void>() {     @Override     public Document doInBackground() {         Document intDoc = loadXML();         return intDoc;     }     @Override     public void done() {         try {             doc = get();         } catch (InterruptedException ex) {             ex.printStackTrace();         } catch (ExecutionException ex) {             ex.printStackTrace();         }     } } 

• register a listener by using the worker SwingWorker.addPropertyChangeListener(PropertyChangeListener) method. The listener will be notified of changes in the worker state.

private Document doc; ... JButton button = new JButton("Open XML"); button.addActionListener(new ActionListener() {     @Override     public void actionPerformed(ActionEvent e) {         SwingWorker<Document, Void> worker              = new SwingWorker<Document, Void>() {              @Override             public Document doInBackground() {                 Document intDoc = loadXML();                 return intDoc;             }             @Override             public void done() {                 try {                     doc = get();                 } catch (InterruptedException ex) {                     ex.printStackTrace();                 } catch (ExecutionException ex) {                     ex.printStackTrace();                 }             }         };         worker.execute();     } }); 

SwingWorker has been part of Java SE only since Java 6.0. Sun has released versions to be used with earlier JDKs, although they were unofficial versions which were not part of the Java SE and were not mentioned in the standard library documentation.^[2] The most recent of these versions dates from 2003 and is often referred to as SwingWorker version 3.^[3] Unfortunately, the JDK 6.0 SwingWorker and the Version 3 SwingWorker use different method names and are not compatible. The backport version (see below) is now recommended for pre-Java 6 usage.

An example for instantiating SwingWorker 3 is shown below:

SwingWorker worker = new SwingWorker() {     public Object construct() {         ... //add the code for the background thread     }     public void finished() {         ... //code that you add here will run in the UI thread     }  }; worker.start();  //Start the background thread 

The start() method executes the code added in the construct() method in a separate thread. To be alerted when the background thread finishes, one need only override the finished() method. The construct() method can return a result which can later be retrieved using SwingWorker's get() method.

A backport of the Java 6 SwingWorker to Java 5 is available at http://swingworker.java.net/^{[permanent dead link‍]}. Apart from the package name ( org.jdesktop.swingworker ), it is compatible with the Java 6 SwingWorker.

• System.ComponentModel.BackgroundWorker - .NET Framework
• flash.system.Worker - Adobe Flash
• android.os.AsyncTask - Android

• SwingWorker class documentation for Java 7.
• Worker Threads and SwingWorker from Oracle's Java Concurrency in Swing tutorial.
• Improve Application Performance With SwingWorker in Java SE 6 by John O'Conner, January 2007.