Package com.marcosavard.commons.util

Class SimpleProgressMonitor

java.lang.Object

com.marcosavard.commons.util.SimpleProgressMonitor

All Implemented Interfaces:

ProgressMonitor

public class SimpleProgressMonitor
extends java.lang.Object
implements ProgressMonitor

A simple implementation of ProgressMonitor

Author:

Marco

Constructor Summary

Constructors

Constructor	Description
SimpleProgressMonitor()

Method Summary

Modifier and Type	Method	Description
void	beginTask(java.lang.String name, int totalWork)	Notifies that the main task is beginning.
void	cancel()	Cancel the running task.
void	done()	Notifies that the work is done; that is, either the main task is completed or the user canceled it.
long	getStartTime()	Get the time when beginTask() has been called.
boolean	isCanceled()	Returns whether cancelation of current operation has been requested.
void	worked(int work)	Notifies that a given number of work unit of the main task has been completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleProgressMonitor

public SimpleProgressMonitor()

Method Detail

beginTask

public void beginTask(java.lang.String name,
                      int totalWork)

Description copied from interface: ProgressMonitor

Notifies that the main task is beginning.

Specified by:

beginTask in interface ProgressMonitor

Parameters:

name - name

getStartTime

public long getStartTime()

Description copied from interface: ProgressMonitor

Get the time when beginTask() has been called.

Specified by:

getStartTime in interface ProgressMonitor

Returns:

the begin time in milliseconds.

worked

public void worked(int work)

Description copied from interface: ProgressMonitor

Notifies that a given number of work unit of the main task has been completed.

Specified by:

worked in interface ProgressMonitor

cancel

public void cancel()

Description copied from interface: ProgressMonitor

Cancel the running task.

Specified by:

cancel in interface ProgressMonitor

done

public void done()

Description copied from interface: ProgressMonitor

Notifies that the work is done; that is, either the main task is completed or the user canceled it.

Specified by:

done in interface ProgressMonitor

isCanceled

public boolean isCanceled()

Description copied from interface: ProgressMonitor

Returns whether cancelation of current operation has been requested.

Specified by:

isCanceled in interface ProgressMonitor

Returns:

true if is canceled