se.entra.phantom.server.phed

Class ProgressMonitor

java.lang.Object

se.entra.phantom.server.phed.ProgressMonitor

All Implemented Interfaces:

ICancel, IFeedBack, IProgressMonitor

public class ProgressMonitor
extends Object
implements IFeedBack

Class calculating progress.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isBatch Flags.
boolean	isVerbose Flags.

Fields inherited from interface com.netphantom.eclipse.IFeedBack

NULL_MONITOR

Fields inherited from interface com.netphantom.eclipse.ICancel

NO_CANCEL

Constructor Summary

Constructors

Constructor and Description
ProgressMonitor(IProgressReport owner) Constructor at first level.

Method Summary

Modifier and Type	Method and Description
void	beginTask(String text, int count) Begins work.
void	done() Completed work.
IFeedBack	getSubMonitor() Gets a sub-monitor of one work unit in parent.
IFeedBack	getSubMonitor(int count) Gets a sub-monitor that takes a certain amount of work units in parent.
boolean	isBatch() Flag indicating this is running in batch mode and no GUI is available.
boolean	isCanceled() Checks if canceled.
boolean	isEclipse() Check to see if this is Eclipse or NetPhantom.
boolean	isVerbose() Testing for verbose output to System.out, used in NetPhantom Editor, but not inside Eclipse.
void	setTaskName(String name) Sets the task name.
void	setTaskName(String name, boolean outputIfVerbose) Sets the task name.
void	subTask(String name) Sets the subtask name.
void	worked() A work unit is done.
void	worked(int count) Some work units are done.
void	worked(int count, String text) Some work units are done, sets text for next operation.
void	worked(String text) A work unit is done, sets text for next operation.

Methods inherited from class java.lang.Object

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

Field Detail

isBatch

public boolean isBatch

Flags.

isVerbose

public boolean isVerbose

Flags.

Constructor Detail

ProgressMonitor

public ProgressMonitor(IProgressReport owner)

Constructor at first level.

Method Detail

isEclipse

public boolean isEclipse()

Check to see if this is Eclipse or NetPhantom.

Specified by:

isEclipse in interface IFeedBack

isVerbose

public boolean isVerbose()

Testing for verbose output to System.out, used in NetPhantom Editor, but not inside Eclipse.

Specified by:

isVerbose in interface IFeedBack

isBatch

public boolean isBatch()

Flag indicating this is running in batch mode and no GUI is available.

Specified by:

isBatch in interface IFeedBack

setTaskName

public void setTaskName(String name)

Sets the task name.

Specified by:

setTaskName in interface IProgressMonitor

setTaskName

public void setTaskName(String name,
                        boolean outputIfVerbose)

Sets the task name.

subTask

public void subTask(String name)

Sets the subtask name.

Specified by:

subTask in interface IProgressMonitor

isCanceled

public boolean isCanceled()

Checks if canceled.

Specified by:

isCanceled in interface ICancel

beginTask

public void beginTask(String text,
                      int count)

Begins work.

Specified by:

beginTask in interface IProgressMonitor

worked

public void worked()

A work unit is done.

Specified by:

worked in interface IProgressMonitor

worked

public void worked(String text)

A work unit is done, sets text for next operation.

Specified by:

worked in interface IProgressMonitor

worked

public void worked(int count)

Some work units are done.

Specified by:

worked in interface IProgressMonitor

worked

public void worked(int count,
                   String text)

Some work units are done, sets text for next operation.

Specified by:

worked in interface IProgressMonitor

getSubMonitor

public IFeedBack getSubMonitor()

Gets a sub-monitor of one work unit in parent.

Specified by:

getSubMonitor in interface IFeedBack

Specified by:

getSubMonitor in interface IProgressMonitor

getSubMonitor

public IFeedBack getSubMonitor(int count)

Gets a sub-monitor that takes a certain amount of work units in parent.

Specified by:

getSubMonitor in interface IFeedBack

Specified by:

getSubMonitor in interface IProgressMonitor

done

public void done()

Completed work.

Specified by:

done in interface IProgressMonitor