Interface IPersistableSourceLocator

  • All Superinterfaces:
    ISourceLocator
    All Known Subinterfaces:
    IPersistableSourceLocator2, ISourceLookupDirector
    All Known Implementing Classes:
    AbstractSourceLookupDirector

    public interface IPersistableSourceLocator
    extends ISourceLocator
    A source locator that can be persisted and restored, to be used with a specific 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
    See Also:
    ILaunch, IStackFrame
    • Method Detail

      • getMemento

        String getMemento()
                   throws CoreException
        Returns a memento that can be used to reconstruct this source locator
        Returns:
        a memento that can be used to reconstruct this source locator
        Throws:
        CoreException - if unable to construct a memento
      • initializeFromMemento

        void initializeFromMemento​(String memento)
                            throws CoreException
        Initializes this source locator based on the given memento.
        Parameters:
        memento - a memento to initialize this source locator
        Throws:
        CoreException - on failure to initialize
      • initializeDefaults

        void initializeDefaults​(ILaunchConfiguration configuration)
                         throws CoreException
        Initializes this source locator to perform default source lookup for the given launch configuration.
        Parameters:
        configuration - launch configuration this source locator will be performing source lookup for
        Throws:
        CoreException - on failure to initialize