org.midica.worker

Class MidicaWorker

java.lang.Object

javax.swing.SwingWorker<java.lang.Exception,java.lang.Void>

org.midica.worker.MidicaWorker

All Implemented Interfaces:

java.lang.Runnable, java.util.concurrent.Future<java.lang.Exception>, java.util.concurrent.RunnableFuture<java.lang.Exception>

Direct Known Subclasses:

DeviceWorker, ExportWorker, ParsingWorker

public abstract class MidicaWorker
extends javax.swing.SwingWorker<java.lang.Exception,java.lang.Void>

This class is the base class for workers that perform time-consuming actions in the background while a WaitView is shown.

The derived worker is executed in the background before the (blocking) setVisible() method of the (modal) waiting dialog is called. That causes the execution of doInBackground() which does the actual work.

After the background work is finished, done() is called and closes the waiting dialog.

Author:

Jan Trukenmüller

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

javax.swing.SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
private WaitView	view

Constructor Summary

Constructors

Constructor and Description
MidicaWorker(WaitView view) Creates a worker for time-consuming background work while a waiting dialog is shown.

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.Exception	doInBackground() Does the background work.
protected void	done() Closes the waiting dialog.

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

view

private WaitView view

Constructor Detail

MidicaWorker

public MidicaWorker(WaitView view)

Creates a worker for time-consuming background work while a waiting dialog is shown.

Parameters:

view - The waiting dialog

Method Detail

doInBackground

protected abstract java.lang.Exception doInBackground()

Does the background work.

Specified by:

doInBackground in class javax.swing.SwingWorker<java.lang.Exception,java.lang.Void>

Returns:

the exception caught during the work or null if no exception is caught

done

protected void done()

Closes the waiting dialog. This method is executed if the background work is finished.

Overrides:

done in class javax.swing.SwingWorker<java.lang.Exception,java.lang.Void>