com.ibm.wala.util

Class ProgressMaster

java.lang.Object

com.ibm.wala.util.ProgressMaster

All Implemented Interfaces:

com.ibm.wala.util.MonitorUtil.IProgressMonitor

public class ProgressMaster
extends Object
implements com.ibm.wala.util.MonitorUtil.IProgressMonitor

A class to control execution through the MonitorUtil.IProgressMonitor interface. This class bounds each work item with a time in milliseconds. If there is no apparent progress within the specified bound, this class cancels itself.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgressMaster.TooMuchMemoryUsed

Field Summary

Fields inherited from interface com.ibm.wala.util.MonitorUtil.IProgressMonitor

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
void	beginTask(String name, int totalWork)
void	cancel()
void	done()
String	getCancelMessage()
int	getMillisPerWorkItem()
boolean	isCanceled()
boolean	lastItemTimedOut() Was the last cancel state due to a timeout?
boolean	lastItemTooMuchMemory()
static ProgressMaster	make(com.ibm.wala.util.MonitorUtil.IProgressMonitor monitor, int msPerWorkItem, boolean checkMemory)
void	reset()
void	setCanceled(boolean value)
void	subTask(String subTask) BEGIN Custom change: subtasks and canceling
void	worked(int work) END Custom change: subtasks and canceling

Methods inherited from class java.lang.Object

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

Method Detail

make

public static ProgressMaster make(com.ibm.wala.util.MonitorUtil.IProgressMonitor monitor,
                  int msPerWorkItem,
                  boolean checkMemory)

beginTask

public void beginTask(String name,
             int totalWork)

Specified by:

beginTask in interface com.ibm.wala.util.MonitorUtil.IProgressMonitor

reset

public void reset()

lastItemTimedOut

public boolean lastItemTimedOut()

Was the last cancel state due to a timeout?

lastItemTooMuchMemory

public boolean lastItemTooMuchMemory()

done

public void done()

Specified by:

done in interface com.ibm.wala.util.MonitorUtil.IProgressMonitor

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface com.ibm.wala.util.MonitorUtil.IProgressMonitor

setCanceled

public void setCanceled(boolean value)

subTask

public void subTask(String subTask)

BEGIN Custom change: subtasks and canceling

Specified by:

subTask in interface com.ibm.wala.util.MonitorUtil.IProgressMonitor

cancel

public void cancel()

Specified by:

cancel in interface com.ibm.wala.util.MonitorUtil.IProgressMonitor

worked

public void worked(int work)

END Custom change: subtasks and canceling

Specified by:

worked in interface com.ibm.wala.util.MonitorUtil.IProgressMonitor

getMillisPerWorkItem

public int getMillisPerWorkItem()

getCancelMessage

public String getCancelMessage()

Specified by:

getCancelMessage in interface com.ibm.wala.util.MonitorUtil.IProgressMonitor