jklustor-all-api-0.0.7-20140619012755 (ChemAxon)


com.chemaxon.calculations.common
Interface SubProgressObserver

All Superinterfaces:
CancelObserver, ProgressObserver

@Beta
public interface SubProgressObserver
extends ProgressObserver

Observer for reporting the progress of subtasks.

This observer is intended to follow the executions of subtasks (using ProgressObserver.subTask(java.lang.String, long)). The only additional constraint is that the explicit signalling of finisging the work (using done() is required; usually by the host task.

Please note that this interface is marked with @Beta annotation, so it can be subject of incompatible changes or removal in later releases.

Author:
Gabor Imre

Field Summary
 
Fields inherited from interface com.chemaxon.calculations.common.CancelObserver
FIRED_PROPERTY_NAME
 
Method Summary
 void done()
          Notifies that the represented task is finished and no further work will be done.
 
Methods inherited from interface com.chemaxon.calculations.common.ProgressObserver
subTask, switchToDeterminate, worked
 
Methods inherited from interface com.chemaxon.calculations.common.CancelObserver
addPropertyChangeListener, isCancelled, removePropertyChangeListener
 

Method Detail

done

void done()
Notifies that the represented task is finished and no further work will be done.

Cancellation has no effect to the progress state, so this method must be invoked when finished, either due normal completion; cancellation or error

This method must be called exactly once.

Throws:
IllegalStateException - When no beginTask(...) invoked or done() is already invoked.

jklustor-all-api-0.0.7-20140619012755 (ChemAxon)