KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > debug > ui > sourcelookup > ISourceLookupResult


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.debug.ui.sourcelookup;
12
13 import org.eclipse.ui.IEditorInput;
14
15 /**
16  * The result of performing source lookup on a debug artifact.
17  * The result contains the resolved source element and description
18  * of an editor (editor id, and editor input) in which to display
19  * the result.
20  * <p>
21  * Clients are not intended to implement this interface.
22  * </p>
23  * @see org.eclipse.debug.ui.DebugUITools#lookupSource(Object, ISourceLocator)
24  * @see org.eclipse.debug.ui.DebugUITools#displaySource(ISourceLookupResult, IWorkbenchPage)
25  * @since 3.1
26  */
27 public interface ISourceLookupResult {
28
29     /**
30      * Returns the artifact for which source lookup was performed,
31      * such as a stack frame.
32      *
33      * @return the artifact for which source lookup was performed
34      */
35     public Object JavaDoc getArtifact();
36     
37     /**
38      * Returns the source element resolved during source lookup,
39      * or <code>null</code> if a source element was not resolved.
40      *
41      * @return resolved source element or <code>null</code> if unknown
42      */
43     public Object JavaDoc getSourceElement();
44         
45     /**
46      * Returns the identifier of an editor used to display this result,
47      * or <code>null</code> if unknown.
48      *
49      * @return the identifier of an editor used to display this result,
50      * or <code>null</code> if unknown
51      */
52     public String JavaDoc getEditorId();
53     
54     /**
55      * Returns the editor input used to display result,
56      * or <code>null</code> if unknown.
57      *
58      * @return the editor input used to display result,
59      * or <code>null</code> if unknown
60      */
61     public IEditorInput getEditorInput();
62 }
63
Popular Tags