Eclipse Plug-in Developer Guide (Galileo) - AbstractDocumentProvider.DocumentProviderOperation (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.texteditor
Class AbstractDocumentProvider.DocumentProviderOperation


java.lang.Object
  
org.eclipse.ui.texteditor.AbstractDocumentProvider.DocumentProviderOperation

All Implemented Interfaces:: IRunnableWithProgress

Enclosing class:: AbstractDocumentProvider

protected abstract static class AbstractDocumentProvider.DocumentProviderOperation
extends Object
implements IRunnableWithProgress
extends Object
implements IRunnableWithProgress

Operation created by the document provider and to be executed by the providers runnable context.

Since:: 3.0

Constructor Summary

protected AbstractDocumentProvider.DocumentProviderOperation ()


Method Summary

protected abstract void execute ( IProgressMonitor monitor)
          The actual functionality of this operation.

void run ( IProgressMonitor monitor)
          Runs this operation.

Methods inherited from class java.lang. Object

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

Constructor Detail

AbstractDocumentProvider.DocumentProviderOperation

protected AbstractDocumentProvider.DocumentProviderOperation()

Method Detail

execute

protected abstract void execute(
IProgressMonitor monitor)
                         throws 
CoreException

The actual functionality of this operation.

Parameters:: monitor - a progress monitor to track execution
Throws:: CoreException - if the execution fails

run

public void run(
IProgressMonitor monitor)
         throws 
InvocationTargetException,
                
InterruptedException

Description copied from interface: IRunnableWithProgress

Runs this operation. Progress should be reported to the given progress monitor. This method is usually invoked by an IRunnableContext's run method, which supplies the progress monitor. A request to cancel the operation should be honored and acknowledged by throwing InterruptedException.

Specified by:: run in interface IRunnableWithProgress

Parameters:: monitor - the progress monitor to use to display progress and receive requests for cancelation
Throws:: InvocationTargetException - if the run method must propagate a checked exception, it should wrap it inside an InvocationTargetException; runtime exceptions are automatically wrapped in an InvocationTargetException by the calling context; InterruptedException - if the operation detects a request to cancel, using IProgressMonitor.isCanceled(), it should exit by throwing InterruptedException
See Also:: IRunnableContext.run(boolean, boolean, org.eclipse.jface.operation.IRunnableWithProgress)