com.chemaxon.calculations.common

Class ObservableProgressObserver

java.lang.Object

com.chemaxon.calculations.common.ObservableProgressObserver

All Implemented Interfaces:

CancelObserver, ProgressObservable, ProgressObserver, AutoCloseable

public class ObservableProgressObserver
extends Object
implements ProgressObserver, ProgressObservable

Implementation that holds observed state, and expose it as a ProgressObservable. Thread-safe.

Constructor Summary

Constructors

Constructor and Description
ObservableProgressObserver()

Method Summary

Modifier and Type	Method and Description
void	addDoneListener(Consumer<ProgressObservable> listener)
void	cancel() Sets the cancelled state.
void	done() Notifies that the represented task is done and no further work will be done.
long	getAccumulatedWork()
Optional<Long>	getTotalWork()
Optional<String>	getWorkUnit()
boolean	isCancelled() Returns whether cancellation of current operation has been requested.
boolean	isDone()
SubProgressObserver	subTask(String name, long work) Follow the processing of a specific amount of work units by a separate observer.
void	switchToDeterminate(long totalWork) Notifies that the remaining amount of work units to complete this task is known.
void	worked(long work) Notifies that a given number of work units has been completed.
void	workUnit(String workUnit) Notifies the measure unit of work (such as 'pc', 'file', 'percent', etc).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.chemaxon.calculations.common.ProgressObserver

close

Constructor Detail

ObservableProgressObserver

public ObservableProgressObserver()

Method Detail

switchToDeterminate

public void switchToDeterminate(long totalWork)

Description copied from interface: ProgressObserver

Notifies that the remaining amount of work units to complete this task is known. (Calling this method is not mandatory.)

Specified by:

switchToDeterminate in interface ProgressObserver

Parameters:

totalWork - The total amount of work represented by this task.

workUnit

public void workUnit(String workUnit)

Description copied from interface: ProgressObserver

Notifies the measure unit of work (such as 'pc', 'file', 'percent', etc). (Calling this method is not mandatory.)

Specified by:

workUnit in interface ProgressObserver

Parameters:

workUnit - the measure unit of work.

worked

public void worked(long work)

Description copied from interface: ProgressObserver

Notifies that a given number of work units has been completed.

Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.

Specified by:

worked in interface ProgressObserver

Parameters:

work - Amount of work reported

done

public void done()

Description copied from interface: ProgressObserver

Notifies that the represented task is done and no further work will be done. Additional calls to this method cause no effect. (idempotency)

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

Specified by:

done in interface ProgressObserver

isCancelled

public boolean isCancelled()

Description copied from interface: CancelObserver

Returns whether cancellation of current operation has been requested.

Long running/memory intensive operations should poll to see if cancelation has been requested. Since time-out based cancelations might be implemented polling should not be done too often.

It is expected that implementations wont return false after a true value returned. It is also expected that implementations tolerate multiple calls regardless of the cancallation state.

Please note that test cases might check for too frequent invocations, so the propagation of any AssertionError thrown by this method should not be obstructed.

It is usually expected that the cancelled task should throw CancellationException and this behavior should be documented in their APIdocs.

Specified by:

isCancelled in interface CancelObserver

Returns:

true if cancellation has been requested, false otherwise.

getTotalWork

public Optional<Long> getTotalWork()

Specified by:

getTotalWork in interface ProgressObservable

getWorkUnit

public Optional<String> getWorkUnit()

Specified by:

getWorkUnit in interface ProgressObservable

getAccumulatedWork

public long getAccumulatedWork()

Specified by:

getAccumulatedWork in interface ProgressObservable

isDone

public boolean isDone()

Specified by:

isDone in interface ProgressObservable

cancel

public void cancel()

Description copied from interface: ProgressObservable

Sets the cancelled state.

Subsequent calls has no effect.

Specified by:

cancel in interface ProgressObservable

addDoneListener

public void addDoneListener(Consumer<ProgressObservable> listener)

Specified by:

addDoneListener in interface ProgressObservable

subTask

public SubProgressObserver subTask(String name,
                                   long work)

Description copied from interface: ProgressObserver

Follow the processing of a specific amount of work units by a separate observer.

The given amount of work on the level of the current observer is considered completed upon ProgressObserver.done() called on the returned subtask's observer.

Cancel propagation is expected to be transparent.

The strict contract regarding the state when ProgressObserver.worked(long) can be called is relaxed in the context of subtask observers: implicitly logging work on the upper level by calling ProgressObserver.done() on the subtask level after the upper level is closed will no cause problem on either level.

Specified by:

subTask in interface ProgressObserver

Parameters:

name - Name of the represented sub task (for example to display)

work - A non-negative number of work units considered to be completed upon finishing the associated subtask.

Returns:

An unitialized observer to be used by a subtask. The returned observer will reflect the same cancelling behavior as the current one.