← Back to branch summary

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

« back to all changes in this revision

Viewing changes to results/plugins/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfigurationV2.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:
results/plugins/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfigurationV2.java
1
 
/*******************************************************************************
2
 
 * Copyright (c) 2003, 2006 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 - Initial API and implementation
10
 
 *******************************************************************************/
11
 
package org.eclipse.cdt.managedbuilder.core;
12
 
 
13
 
import org.eclipse.core.resources.IProject;
14
 
import org.eclipse.core.resources.IResource;
15
 
 
16
 
/**
17
 
 * This class represents a project configuration in the old (CDT 2.0)
18
 
 * managed build system model.
19
 
 * <p>  
20
 
 * The configuration contains one or more children of type tool-reference.
21
 
 *
22
 
 * This class was deprecated in 2.1
23
 
 */
24
 
public interface IConfigurationV2 extends IBuildObject {
25
 
        // Schema element names
26
 
        public static final String CONFIGURATION_ELEMENT_NAME = "configuration";        //$NON-NLS-1$
27
 
        public static final String TOOLREF_ELEMENT_NAME = "toolReference";      //$NON-NLS-1$
28
 
        public static final String PARENT = "parent";   //$NON-NLS-1$
29
 
 
30
 
        /**
31
 
         * Projects have C or CC natures. Tools can specify a filter so they are not 
32
 
         * misapplied to a project. This method allows the caller to retrieve a list 
33
 
         * of tools from a project that are correct for a project's nature.  
34
 
         * 
35
 
         * @param project the project to filter for
36
 
         * @return an array of <code>ITools</code> that have compatible filters 
37
 
         * for the specified project
38
 
         */
39
 
        ITool[] getFilteredTools(IProject project);
40
 
        
41
 
        /**
42
 
         * Returns the resource that owns the project that owns the configuration.
43
 
         * @return
44
 
         */
45
 
        public IResource getOwner();
46
 
        
47
 
        /**
48
 
         * Answers the configuration that this configuration is based on. 
49
 
         * 
50
 
         * @return
51
 
         */
52
 
        public IConfigurationV2 getParent();
53
 
        
54
 
        /**
55
 
         * Returns the target for this configuration.
56
 
         * 
57
 
         * @return
58
 
         */
59
 
        public ITarget getTarget();
60
 
        
61
 
        /**
62
 
         * Answers the <code>ITool</code> in the receiver with the same 
63
 
         * id as the argument, or <code>null</code>. 
64
 
         * 
65
 
         * @param id unique identifier to search for
66
 
         * @return ITool
67
 
         */
68
 
        public ITool getToolById(String id);
69
 
        
70
 
        /**
71
 
         * Returns the tools that are used in this configuration.
72
 
         * 
73
 
         * @return ITool[]
74
 
         */
75
 
        public ITool[] getTools();
76
 
        
77
 
        /**
78
 
         * Returns the tool references that are children of this configuration.
79
 
         * 
80
 
         * @return
81
 
         */
82
 
        public IToolReference[] getToolReferences();
83
 
 
84
 
        /**
85
 
         * Answers <code>true</code> the receiver has changes that need to be saved 
86
 
         * in the project file, else <code>false</code>.
87
 
         * 
88
 
         * @return boolean 
89
 
         */
90
 
        public boolean isDirty();
91
 
 
92
 
        /**
93
 
         * Answers whether the receiver has been changed and requires the 
94
 
         * project to be rebuilt.
95
 
         * 
96
 
         * @return <code>true</code> if the receiver contains a change 
97
 
         * that needs the project to be rebuilt
98
 
         */
99
 
        public boolean needsRebuild();
100
 
 
101
 
        /**
102
 
         * Sets the element's "dirty" (have I been modified?) flag.
103
 
         * 
104
 
         * @param isDirty
105
 
         */
106
 
        public void setDirty(boolean isDirty);
107
 
 
108
 
        /**
109
 
         * Sets the name of the receiver to the value specified in the argument
110
 
         * 
111
 
         * @param name
112
 
         */
113
 
        public void setName(String name);
114
 
 
115
 
        /**
116
 
         * Sets the value of a boolean option for this configuration.
117
 
         * 
118
 
         * @param option The option to change.
119
 
         * @param value The value to apply to the option.
120
 
         * 
121
 
         * @throws BuildException
122
 
         */
123
 
        public void setOption(IOption option, boolean value) 
124
 
                throws BuildException;  
125
 
 
126
 
        /**
127
 
         * Sets the value of a string option for this configuration.
128
 
         * 
129
 
         * @param option The option that will be effected by change.
130
 
         * @param value The value to apply to the option.
131
 
         * 
132
 
         * @throws BuildException
133
 
         */
134
 
        public void setOption(IOption option, String value)
135
 
                throws BuildException;
136
 
        
137
 
        /**
138
 
         * Sets the value of a list option for this configuration.
139
 
         * 
140
 
         * @param option The option to change.
141
 
         * @param value The values to apply to the option.
142
 
         * 
143
 
         * @throws BuildException
144
 
         */
145
 
        public void setOption(IOption option, String[] value)
146
 
                throws BuildException;
147
 
 
148
 
        /**
149
 
         * Sets the rebuild state in the receiver. 
150
 
         * 
151
 
         * @param rebuild <code>true</code> will force a rebuild the next time the project builds
152
 
         * @see org.eclipse.cdt.managedbuilder.core.IManagedBuildInfo#setRebuildState(boolean)
153
 
         */
154
 
        void setRebuildState(boolean rebuild);
155
 
 
156
 
        /**
157
 
         * Overrides the tool command for a tool defined in the receiver.
158
 
         * 
159
 
         * @param tool The tool that will have its command modified
160
 
         * @param command The command
161
 
         */
162
 
        public void setToolCommand(ITool tool, String command);
163
 
 
164
 
        /**
165
 
         * Sets the configuration that was created from this V2.0 configuration.
166
 
         * 
167
 
         * @param config
168
 
         */
169
 
        public void setCreatedConfig(IConfiguration config);
170
 
 
171
 
        /**
172
 
         * Returns the configuration that was created from this V2.0 configuration.
173
 
         * 
174
 
         * @return IConfiguration
175
 
         */
176
 
        public IConfiguration getCreatedConfig();
177
 
 
178
 
}