IPersistableSourceLocator

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> debug >> core >> [ model overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.debug.core.model
Interface IPersistableSourceLocator

All Superinterfaces:: ISourceLocator

public interface IPersistableSourceLocator
extends ISourceLocator

A source locator that can be persisted and restored, to be used with a specfic launch configuration. The debug plug-in defines a source locator extension point for persistable source locators.

A source locator extension is defined in plugin.xml. Following is an example definition of a source locator extension.

 <extension point="org.eclipse.debug.core.sourceLocators">
   <sourceLocator 
      id="com.example.ExampleIdentifier"
      class="com.example.ExampleSourceLocator"
      name="Example Source Locator">
   </sourceLocator>
 </extension>

The attributes are specified as follows:

id specifies a unique identifier for this source locator.
class specifies the fully qualified name of the Java class that implements IPersistableSourceLocator.
name a human readable name, describing the type of this source locator.

Clients may implement this interface.

Since:: 2.0

Method Summary

java.lang.String getMemento()
          Returns a memento that can be used to reconstruct this source locator

void initializeDefaults(org.eclipse.debug.core.ILaunchConfiguration configuration)
          Initializes this source locator to perform default source lookup for the given launch configuration.

void initializeFromMemento(java.lang.String memento)
          Initializes this source locator based on the given memento.

Methods inherited from interface org.eclipse.debug.core.model.ISourceLocator

getSourceElement

Method Detail

getMemento

public java.lang.String getMemento()
                            throws org.eclipse.core.runtime.CoreException

Returns a memento that can be used to reconstruct this source locator

initializeFromMemento

public void initializeFromMemento(java.lang.String memento)
                           throws org.eclipse.core.runtime.CoreException

Initializes this source locator based on the given memento.

initializeDefaults

public void initializeDefaults(org.eclipse.debug.core.ILaunchConfiguration configuration)
                        throws org.eclipse.core.runtime.CoreException

Initializes this source locator to perform default source lookup for the given launch configuration.