Eclipse RSE Development Guide (Galileo) - SystemOperationMonitor (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.services.clientserver
Class SystemOperationMonitor


java.lang.Object
  
org.eclipse.rse.services.clientserver.SystemOperationMonitor

All Implemented Interfaces:: ISystemOperationMonitor

public class SystemOperationMonitor
extends Object
implements ISystemOperationMonitor
extends Object
implements ISystemOperationMonitor

A monitor to support cancellation of operations in an environment where Eclipse IProgressMonitor is not available.

Since:: 3.0

Constructor Summary

SystemOperationMonitor ()


Method Summary

boolean isCancelled ()
          Returns whether cancelation of current operation has been requested.

boolean isDone ()
          Notifies that the work is done; that is, either the main task is completed or the user cancelled it.

void setCancelled (boolean value)
          Sets the cancel state to the given value.

void setDone (boolean value)
          Sets the done state to the given value.

Methods inherited from class java.lang. Object

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

Constructor Detail

SystemOperationMonitor

public SystemOperationMonitor()

Method Detail

isDone

public boolean isDone()

Description copied from interface: ISystemOperationMonitor

Notifies that the work is done; that is, either the main task is completed or the user cancelled it. This method may be called more than once (implementations should be prepared to handle this case).

Specified by:: isDone in interface ISystemOperationMonitor

setDone

public void setDone(boolean value)

Description copied from interface: ISystemOperationMonitor

Sets the done state to the given value.

Specified by:: setDone in interface ISystemOperationMonitor

Parameters:: value - true indicates that this operation has finished false clears this flag
See Also:: ISystemOperationMonitor.isDone()

isCancelled

public boolean isCancelled()

Description copied from interface: ISystemOperationMonitor

Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

Specified by:: isCancelled in interface ISystemOperationMonitor

Returns:: true if cancellation has been requested, and false otherwise
See Also:: ISystemOperationMonitor.setCancelled(boolean)

setCancelled

public void setCancelled(boolean value)

Description copied from interface: ISystemOperationMonitor

Sets the cancel state to the given value.

Specified by:: setCancelled in interface ISystemOperationMonitor

Parameters:: value - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag
See Also:: ISystemOperationMonitor.isCancelled()