com.toolsverse.util.concurrent

Class ConcurrentAdapter

Object

com.toolsverse.util.concurrent.ConcurrentAdapter

All Implemented Interfaces:

Runnable, Callable<Object>

Direct Known Subclasses:

ConcurrentAdapter.HeadlessConcurrentAdapter

public abstract class ConcurrentAdapter
extends Object
implements Runnable, Callable<Object>

In the typical client program it is a good practice to separate UI thread and service execution thread. For example when user clicks on "Save" button the code which saves data into the database is executed. Until it's done the UI "freezes" unless UI thread is separated from the "save" thread. The purpose of this class is to do just that. The particular implementation's of this class must implement abstract methods such as execute(), done(), etc.

Do: separate UI update code and service execution code

Do not: put UI code in the service execution thread and vice versa

In the example below the particular implementation of the ConcurrentAdapter is executed when user clicks on Test Connection button:

 public void testConnection()
 {
      ConcurrentFeature concurrentFeature = new ConcurrentFeature(true);
      concurrentFeature.setMessage(TestConnectionResource.TESTING_CONNECTION
              .getValue());
      
      ConcurrentAdapter concurrentAdapter = new ConcurrentAdapter()
      {
          String status = "";
          
          public void canceled()
          {
          }
          
          public void done()
          {
              getField().setText(status);
              
              if (TestConnectionResource.CONNECTION_IS_OK.getValue()
                      .equalsIgnoreCase(status))
                  getField().setForeground(Color.BLACK);
              else
                  getField().setForeground(Color.RED);
          }
          
          public void execute()
              throws Exception
          {
              TestService testService = ServiceFactory
                      .getService(TestService.class);
              
              status = testService.testConnection(_connectionProvider,
                      _connectionParamsProvider.getConnectionParams());
          }
          
          public void onException(Throwable ex)
          {
              DefaultExceptionHandler.instance().handleException(
                      Logger.SEVERE,
                      this,
                      TestConnectionResource.ERROR_TESTING_CONNECTION
                              .getValue(), ex);
          }
          
      };
      
      concurrentAdapter.executeTask(concurrentFeature);
 }
 

Since:

2.0

Version:

2.0

See Also:

ConcurrentFeature

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConcurrentAdapter.HeadlessConcurrentAdapter

Constructor Summary

Constructors

Constructor and Description
ConcurrentAdapter()

Method Summary

Modifier and Type	Method and Description
Object	call()
abstract void	canceled() Executed when service thread is interrupted before it finished.
abstract void	done() Executed when service thread is finished.
abstract void	execute() Executes service thread.
void	executeTask() Execute task and waits until service thread is finished or interrupted and UI is updated.
void	executeTask(ConcurrentFeature concurrentFeature) Execute task and waits until service thread is finished or interrupted and UI is updated.
ConcurrentFeature	getConcurrentFeature() Gets the concurrent feature.
abstract void	onException(Throwable ex) Executed if service thread throws an exception.
void	progress(Object data) Display progress.
void	run()
void	start() Start.

Methods inherited from class Object

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

Constructor Detail

ConcurrentAdapter

public ConcurrentAdapter()

Method Detail

call

public final Object call()
                  throws Exception

Specified by:

call in interface Callable<Object>

Throws:

Exception

canceled

public abstract void canceled()

Executed when service thread is interrupted before it finished. Put clean up code here.

done

public abstract void done()

Executed when service thread is finished. Put UI update code here.

execute

public abstract void execute()
                      throws Exception

Executes service thread. Put main execution code here.

Throws:

Exception - in case of any error

executeTask

public void executeTask()

Execute task and waits until service thread is finished or interrupted and UI is updated. Uses default ConcurrentFeature.

executeTask

public void executeTask(ConcurrentFeature concurrentFeature)

Execute task and waits until service thread is finished or interrupted and UI is updated. Or if ConcurrentFeature#isEnableBackground() == true execute task in background

Parameters:

concurrentFeature - the ConcurrentFeature

getConcurrentFeature

public ConcurrentFeature getConcurrentFeature()

Gets the concurrent feature.

Returns:

the concurrent feature

onException

public abstract void onException(Throwable ex)

Executed if service thread throws an exception. Put error handling code here.

Parameters:

ex - the ex

progress

public void progress(Object data)

Display progress.

run

public final void run()

Specified by:

run in interface Runnable

start

public void start()

Start.