EclipseProgressObserver (EASy-Producer Documentation API)

java.lang.Object
- net.ssehub.easy.basics.progress.ProgressObserver
- - net.ssehub.easy.basics.progress.BasicProgressObserver
  - - net.ssehub.easy.producer.eclipse.observer.EclipseProgressObserver

```
public class EclipseProgressObserver
extends BasicProgressObserver
```
Observes the progress of a longer lasting task for the eclipse ui.

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`private static class`	`EclipseProgressObserver.MyProgressMonitor`	Wraps the eclipse progress monitor to the basic progress observer interface.

Nested classes/interfaces inherited from class net.ssehub.easy.basics.progress.BasicProgressObserver
BasicProgressObserver.IProgressMonitor

Nested classes/interfaces inherited from class net.ssehub.easy.basics.progress.ProgressObserver
ProgressObserver.ISubtask, ProgressObserver.ITask

Field Summary

Fields
Modifier and Type Field Description

private EclipseProgressObserver.MyProgressMonitor monitor
- Fields inherited from class net.ssehub.easy.basics.progress.ProgressObserver
  NO_OBSERVER, NO_SUBTASK

Constructor Summary

Constructors
Constructor Description

EclipseProgressObserver()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`register(org.eclipse.core.runtime.IProgressMonitor monitor)`	Sets the monitor to this progress observer.
`void`	`unregister(org.eclipse.core.runtime.IProgressMonitor monitor)`	Sets this monitor to `null` if the current monitor is the same as the specified monitor.

Methods inherited from class net.ssehub.easy.basics.progress.BasicProgressObserver
notifyEnd, notifyProgress, notifyStart, register, registerSubtask, registerTask, unregister

Methods inherited from class net.ssehub.easy.basics.progress.ProgressObserver
notifyEnd, notifyProgress, notifyProgress, notifyProgress, notifyStart

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - monitor
```
private EclipseProgressObserver.MyProgressMonitor monitor
```
- Constructor Detail
  - EclipseProgressObserver
```
public EclipseProgressObserver()
```
- Method Detail
  - register
```
public void register(org.eclipse.core.runtime.IProgressMonitor monitor)
```
    Sets the monitor to this progress observer.
    Overwrites already set monitors.
    
    Parameters:
    
    monitor - The monitor which should be added to this observer.
  - unregister
```
public void unregister(org.eclipse.core.runtime.IProgressMonitor monitor)
```
    Sets this monitor to null if the current monitor is the same as the specified monitor.
    
    Parameters:
    
    monitor - If the given monitor is the same monitor as the monitor of this observer instance the monitor of this observer will be set to null otherwise will nothing happen.