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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/*******************************************************************************
* Copyright (c) 2000, 2008 QNX Software Systems and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* QNX Software Systems - Initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.core.model;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
/**
*/
public abstract class PathEntryContainerInitializer {
/**
* Creates a new cpath container initializer.
*/
public PathEntryContainerInitializer() {
}
public abstract void initialize(IPath containerPath, ICProject project) throws CoreException;
/**
* Returns <code>true</code> if this container initializer can be requested to perform updates
* on its own container values. If so, then an update request will be performed using
* <code>PathEntryContainerInitializer#requestPathEntryContainerUpdate</code>/
* <p>
* @param containerPath the path of the container which requires to be updated
* @param project the project for which the container is to be updated
* @return returns <code>true</code> if the container can be updated
*/
public boolean canUpdatePathEntryContainer(IPath containerPath, ICProject project) {
// By default, path container initializers do not accept updating containers
return false;
}
/**
* Request a registered container definition to be updated according to a container suggestion. The container suggestion
* only acts as a place-holder to pass along the information to update the matching container definition(s) held by the
* container initializer. In particular, it is not expected to store the container suggestion as is, but rather adjust
* the actual container definition based on suggested changes.
* <p>
* IMPORTANT: In reaction to receiving an update request, a container initializer will update the corresponding
* container definition (after reconciling changes) at its earliest convenience, using
* <code>CoreModel#setPathContainer(IPath, ICProject[], IPathEntryContainer[], IProgressMonitor)</code>.
* Until it does so, the update will not be reflected in the Java Model.
* <p>
* In order to anticipate whether the container initializer allows to update its containers, the predicate
* <code>PathEntryContainerInitializer#canUpdatePathEntryContainer</code> should be used.
* <p>
* @param containerPath the path of the container which requires to be updated
* @param project the project for which the container is to be updated
* @param containerSuggestion a suggestion to update the corresponding container definition
* @throws CoreException when <code>CoreModel#setPathEntryContainer</code> would throw any.
* @see CoreModel#setPathEntryContainer(ICProject[], IPathEntryContainer, org.eclipse.core.runtime.IProgressMonitor)
* @see #canUpdatePathEntryContainer(IPath, ICProject)
*/
public void requestPathEntryContainerUpdate(IPath containerPath, ICProject project, IPathEntryContainer containerSuggestion) throws CoreException {
// By default, path container initializers do not accept updating containers
}
public String getDescription(IPath containerPath, ICProject project) {
// By default, a container path is the only available description
return containerPath.makeRelative().toString();
}
}
|
