← Back to branch summary

~ubuntu-branches/debian/sid/eclipse-cdt/sid

« back to all changes in this revision

Viewing changes to debug/org.eclipse.cdt.debug.core/src/org/eclipse/cdt/debug/core/sourcelookup/ICSourceLocation.java

  • Committer: Package Import Robot
  • Author(s): Jakub Adam
  • Date: 2011-10-06 21:15:04 UTC
  • mfrom: (1.1.4)
  • Revision ID: package-import@ubuntu.com-20111006211504-8dutmljjih0zikfv
Tags: 8.0.1-1
* New upstream release.
* Split the JNI packages into a separate architecture dependent
  package and made eclipse-cdt architecture independent.
* Install JNI libraries into multiarch aware location
* Bumped Standards-Version to 3.9.2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debug/org.eclipse.cdt.debug.core/src/org/eclipse/cdt/debug/core/sourcelookup/ICSourceLocation.java
 
1
/*******************************************************************************
 
2
 * Copyright (c) 2000, 2006 QNX Software Systems 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
 *     QNX Software Systems - Initial API and implementation
 
10
 *******************************************************************************/
 
11
package org.eclipse.cdt.debug.core.sourcelookup;
 
12
 
 
13
import org.eclipse.core.runtime.CoreException;
 
14
import org.eclipse.core.runtime.IAdaptable;
 
15
 
 
16
/**
 
17
 * 
 
18
 * A source location defines the location of a repository
 
19
 * of source code. A source location is capable of retrieving
 
20
 * source elements.
 
21
 * <p>
 
22
 * For example, a source location could be a project, zip/archive
 
23
 * file, or a directory in the file system.
 
24
 * </p>
 
25
 * 
 
26
 * @since Sep 23, 2002
 
27
 */
 
28
public interface ICSourceLocation extends IAdaptable
 
29
{
 
30
        /**
 
31
         * Returns an object representing the source code
 
32
         * for a file with the specified name, or <code>null</code>
 
33
         * if none could be found. The source element 
 
34
         * returned is implementation specific - for example, a
 
35
         * resource, a local file, a zip file entry, etc.
 
36
         * 
 
37
         * @param name the name of the object for which source is being searched for
 
38
         * 
 
39
         * @return source element
 
40
         * @exception CoreException if an exception occurs while searching for the specified source element
 
41
         */
 
42
        Object findSourceElement( String name ) throws CoreException;
 
43
 
 
44
        /**
 
45
         * Returns a memento for this source location from which this
 
46
         * source location can be reconstructed.
 
47
         * 
 
48
         * @return a memento for this source location
 
49
         * @exception CoreException if unable to create a memento
 
50
         */
 
51
        String getMemento() throws CoreException;
 
52
        
 
53
        /**
 
54
         * Initializes this source location from the given memento.
 
55
         * 
 
56
         * @param memento a memento generated by this source location
 
57
         * @exception CoreException if unable to initialize this source
 
58
         *      location
 
59
         */
 
60
        void initializeFrom( String memento ) throws CoreException;
 
61
 
 
62
        /**
 
63
         * Returns whether to search for all source elements, or just the first match.
 
64
         *  
 
65
         * @return whether to search for all source elements, or just the first match
 
66
         */
 
67
        boolean searchForDuplicateFiles();
 
68
 
 
69
        /**
 
70
         * Sets the value of the 'search for duplicate source files' flag.
 
71
         * 
 
72
         * @param search - a value to set
 
73
         */
 
74
        void setSearchForDuplicateFiles( boolean search );
 
75
 
 
76
        void dispose();
 
77
}