Eclipse Plug-in Developer Guide (Galileo) - ExportBreakpointsOperation (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.debug.ui.actions
Class ExportBreakpointsOperation


java.lang.Object
  
org.eclipse.debug.ui.actions.ExportBreakpointsOperation

All Implemented Interfaces:: IRunnableWithProgress

public class ExportBreakpointsOperation
extends Object
implements IRunnableWithProgress
extends Object
implements IRunnableWithProgress

Exports breakpoints to a file or string buffer.

This class may be instantiated.

Since:: 3.2
Restriction:: This class is not intended to be subclassed by clients.

Constructor Summary

ExportBreakpointsOperation ( IBreakpoint[] breakpoints)
          Constructs an operation to export breakpoints to a string buffer.

ExportBreakpointsOperation ( IBreakpoint[] breakpoints, String fileName)
          Constructs an operation to export breakpoints to a file.

Method Summary

StringBuffer getBuffer ()
          Returns a string buffer containing a memento of the exported breakpoints or null if the operation was configured to export to a file.

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

ExportBreakpointsOperation

public ExportBreakpointsOperation(
IBreakpoint[] breakpoints,
                                  
String fileName)

Constructs an operation to export breakpoints to a file.

Parameters:: breakpoints - the breakpoints to export; fileName - absolute path of file to export breakpoints to - the file will be overwritten if it already exists

ExportBreakpointsOperation

public ExportBreakpointsOperation(
IBreakpoint[] breakpoints)

Constructs an operation to export breakpoints to a string buffer. The buffer is available after the operation is run via getBuffer().

Parameters:: breakpoints - the breakpoints to export
Since:: 3.5

Method Detail

run

public void run(
IProgressMonitor monitor)
         throws 
InvocationTargetException

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
See Also:: IRunnableContext.run(boolean, boolean, org.eclipse.jface.operation.IRunnableWithProgress)

getBuffer

public 
StringBuffer getBuffer()

Returns a string buffer containing a memento of the exported breakpoints or null if the operation was configured to export to a file. The memento can be used to import breakpoints into the workspace using an ImportBreakpointsOperation.

Returns:: a string buffer containing a memento of the exported breakpoints or null if the operation was configured to export to a file
Since:: 3.5