com.businessobjects.sdk.lcm

Class AbstractProgressMonitor

java.lang.Object

com.businessobjects.sdk.lcm.AbstractProgressMonitor

All Implemented Interfaces:

IProgressMonitor

public abstract class AbstractProgressMonitor
extends Object
implements IProgressMonitor

Provides basic implementation of the progress monitor interface with configurable output.

Method Summary

Modifier and Type	Method and Description
void	addWork(int deltaSteps) Notifies that current task has augmented by given increment so delaying its completion.
void	beginTask(String msg, Integer totalSteps) Notifies that a possibly lengthly task consisting of specified number of steps has started.
void	done() Notifies that current task has ended.
abstract void	output(String msg) Outputs progress monitoring activity.
void	worked(int deltaSteps) Notifies that current task has stepped by given increment.

Methods inherited from class java.lang.Object

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

Method Detail

beginTask

public void beginTask(String msg,
                      Integer totalSteps)

Description copied from interface: IProgressMonitor

Notifies that a possibly lengthly task consisting of specified number of steps has started.

Specified by:

beginTask in interface IProgressMonitor

Parameters:

msg - task description

totalSteps - total number of step or null if unknown

done

public void done()

Description copied from interface: IProgressMonitor

Notifies that current task has ended.

Specified by:

done in interface IProgressMonitor

worked

public void worked(int deltaSteps)

Description copied from interface: IProgressMonitor

Notifies that current task has stepped by given increment.

Specified by:

worked in interface IProgressMonitor

Parameters:

deltaSteps - step increment

addWork

public void addWork(int deltaSteps)

Description copied from interface: IProgressMonitor

Notifies that current task has augmented by given increment so delaying its completion.

Specified by:

addWork in interface IProgressMonitor

Parameters:

deltaSteps - step increment

output

public abstract void output(String msg)

Outputs progress monitoring activity.

Parameters:

msg - current activity message