Package net.ssehub.easy.producer.eclipse.observer

Class EclipseProgressObserver.MyProgressMonitor

java.lang.Object

net.ssehub.easy.producer.eclipse.observer.EclipseProgressObserver.MyProgressMonitor

All Implemented Interfaces:

BasicProgressObserver.IProgressMonitor

Enclosing class:

EclipseProgressObserver

private static class EclipseProgressObserver.MyProgressMonitor
extends java.lang.Object
implements BasicProgressObserver.IProgressMonitor

Wraps the eclipse progress monitor to the basic progress observer interface.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private org.eclipse.core.runtime.IProgressMonitor	monitor

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MyProgressMonitor(org.eclipse.core.runtime.IProgressMonitor monitor)	Creates a wrapping instance.

Method Summary

Modifier and Type	Method	Description
void	beginTask(java.lang.String name, int max)	Begins the task with the given name.
private org.eclipse.core.runtime.IProgressMonitor	getMonitor()	Returns the monitor instance.
void	setTaskName(java.lang.String name)	Sets the name of the current main task.
void	subTask(java.lang.String name)	Informs about executing a sub-task.
void	worked(int step)	Informs that the given step within the maximum number of steps of the actual task has been completed.

Methods inherited from class java.lang.Object

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

Field Detail

monitor

private org.eclipse.core.runtime.IProgressMonitor monitor

Constructor Detail

MyProgressMonitor

private MyProgressMonitor(org.eclipse.core.runtime.IProgressMonitor monitor)

Creates a wrapping instance.

Parameters:

monitor - the eclipse monitor instance

Method Detail

getMonitor

private org.eclipse.core.runtime.IProgressMonitor getMonitor()

Returns the monitor instance.

Returns:

the instance

setTaskName

public void setTaskName(java.lang.String name)

Description copied from interface: BasicProgressObserver.IProgressMonitor

Sets the name of the current main task.

Specified by:

setTaskName in interface BasicProgressObserver.IProgressMonitor

Parameters:

name - the name

beginTask

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

Description copied from interface: BasicProgressObserver.IProgressMonitor

Begins the task with the given name.

Specified by:

beginTask in interface BasicProgressObserver.IProgressMonitor

Parameters:

name - the name

max - the maximum number of steps

worked

public void worked(int step)

Description copied from interface: BasicProgressObserver.IProgressMonitor

Informs that the given step within the maximum number of steps of the actual task has been completed.

Specified by:

worked in interface BasicProgressObserver.IProgressMonitor

Parameters:

step - the step number

subTask

public void subTask(java.lang.String name)

Description copied from interface: BasicProgressObserver.IProgressMonitor

Informs about executing a sub-task.

Specified by:

subTask in interface BasicProgressObserver.IProgressMonitor

Parameters:

name - the name of the sub-task