org.gvsig.utils.swing.threads

Class DefaultCancellableMonitorable

java.lang.Object

org.gvsig.utils.swing.threads.DefaultCancellableMonitorable

All Implemented Interfaces:

Cancellable, CancellableMonitorable, Monitorable

Direct Known Subclasses:

AbstractMonitorableTask

public class DefaultCancellableMonitorable
extends java.lang.Object
implements CancellableMonitorable

Default very easy implementation of CancellableMonitorable

Constructor Summary

Constructors

Constructor and Description
DefaultCancellableMonitorable()

Method Summary

Modifier and Type	Method and Description
int	getCurrentStep() Return the number of steps processed
int	getFinalStep()
int	getInitialStep()
boolean	isCanceled() Determines if the related task must be canceled.
boolean	isDeterminatedProcess() Tells if the process is monitoring is defined
void	reportStep() Report to monitor that an individual step was processed.
void	reset() Sets initial default monitorization values
void	setCanceled(boolean canceled) Sets if the related task must be canceled.
void	setCurrentStep(int currentStep) Allows to modify current step.
void	setDeterminatedProcess(boolean determinated) Reports to the monitor that the process is monitoring is (or not) a defined process.
void	setFinalStep(int step) report monitor what number has the final step of the process is monitoring (no apply to undefined process)
void	setInitialStep(int step) report monitor what number has the initial step of the process is monitoring

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCancellableMonitorable

public DefaultCancellableMonitorable()

Method Detail

isCanceled

public boolean isCanceled()

Description copied from interface: Cancellable

Determines if the related task must be canceled.

Specified by:

isCanceled in interface Cancellable

Returns:

true if task must been canceled; otherwise false

See Also:

Cancellable.setCanceled(boolean)

reportStep

public void reportStep()

Description copied from interface: Monitorable

Report to monitor that an individual step was processed.

Specified by:

reportStep in interface Monitorable

getCurrentStep

public int getCurrentStep()

Description copied from interface: Monitorable

Return the number of steps processed

Specified by:

getCurrentStep in interface Monitorable

Returns:

setInitialStep

public void setInitialStep(int step)

Description copied from interface: Monitorable

report monitor what number has the initial step of the process is monitoring

Specified by:

setInitialStep in interface Monitorable

setFinalStep

public void setFinalStep(int step)

Description copied from interface: Monitorable

report monitor what number has the final step of the process is monitoring (no apply to undefined process)

Specified by:

setFinalStep in interface Monitorable

setDeterminatedProcess

public void setDeterminatedProcess(boolean determinated)

Description copied from interface: Monitorable

Reports to the monitor that the process is monitoring is (or not) a defined process. A defined process is a process whose number of step is predefined (in front of not defined process, which may run in an unknown number of steps)

Specified by:

setDeterminatedProcess in interface Monitorable

isDeterminatedProcess

public boolean isDeterminatedProcess()

Description copied from interface: Monitorable

Tells if the process is monitoring is defined

Specified by:

isDeterminatedProcess in interface Monitorable

Returns:

setCanceled

public void setCanceled(boolean canceled)

Description copied from interface: Cancellable

Sets if the related task must be canceled.

Specified by:

setCanceled in interface Cancellable

Parameters:

canceled - true if the task must be canceled; otherwise false

See Also:

Cancellable.isCanceled()

reset

public void reset()

Description copied from interface: Monitorable

Sets initial default monitorization values

Specified by:

reset in interface Monitorable

getInitialStep

public int getInitialStep()

Specified by:

getInitialStep in interface Monitorable

getFinalStep

public int getFinalStep()

Specified by:

getFinalStep in interface Monitorable

setCurrentStep

public void setCurrentStep(int currentStep)

Description copied from interface: Monitorable

Allows to modify current step.

Specified by:

setCurrentStep in interface Monitorable