blob: 5468772189c796711717bde17b6294524e7d75e8 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
/*******************************************************************************
* Copyright (c) 2000, 2009 QNX Software Systems and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* QNX Software Systems - Initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.core.model;
import org.eclipse.core.runtime.IPath;
/**
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IPathEntryContainer {
/**
* Answers the set of path entries this container is mapping to.
* <p>
* The set of entries associated with a container may contain any of the following:
* <ul>
* <li> library entries (<code>CDT_LIBRARY</code>) </li>
* <li> project entries (<code>CDT_PROJECT</code>) </li>
* <li> macro entries (<code>CDT_MACRO</code>) </li>
* <li> include entries (<code>CDT_INCLUDE</code>) </li>
* </ul>
* A container can neither reference further containers.
*
* @return IPathEntry[] - the entries this container represents
* @see IPathEntry
*/
IPathEntry[] getPathEntries();
/**
* Answers a readable description of this container
*
* @return String - a string description of the container
*/
String getDescription();
/**
* Answers the container path identifying this container.
* A container path is formed by a first ID segment followed with extra segments, which
* can be used as additional hints for resolving to this container.
* <p>
* The container ID is also used to identify a<code>ClasspathContainerInitializer</code>
* registered on the extension point "org.eclipse.jdt.core.classpathContainerInitializer", which can
* be invoked if needing to resolve the container before it is explicitly set.
* <p>
* @return IPath - the container path that is associated with this container
*/
IPath getPath();
}
|
