|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IManagedProject
This class represents a project instance in the managed build system. Project instances are stored in the .cdtbuild file. Note that there is no reason to define a project element in a manifest file - it would never be used.
The following steps occur when a CDT user creates a new Managed Build project: 1. A new project element is created. Its projectType attribute is set to the projectType that the user selected. Its name attribute is set to the project name that the user entered. 2. When the user adds a default configuration, a configuration element is created as a child of the project element created in step 1. 3. Add a tool-chain element that specifies as its superClass the tool-chain that is the child of the selected configuration element. 4. For each tool element child of the tool-chain that is the child of the selected configuration element, create a tool element child of the cloned configuration's tool-chain element that specifies the original tool element as its superClass. This prepares the new project/configurations for modification by the user.
Field Summary | |
---|---|
static java.lang.String |
BUILD_ARTEFACT_TYPE
|
static java.lang.String |
BUILD_PROPERTIES
|
static java.lang.String |
MANAGED_PROJECT_ELEMENT_NAME
|
static java.lang.String |
PROJECTTYPE
|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Method Summary | |
---|---|
IConfiguration |
createConfiguration(IConfiguration parent,
java.lang.String id)
Creates a configuration for this project populated with the tools and options settings from the parent configuration. |
IConfiguration |
createConfigurationClone(IConfiguration parent,
java.lang.String id)
Creates a configuration for this project populated with the tools and options settings from the parent configuration. |
IConfiguration |
getConfiguration(java.lang.String id)
Returns the configuration with the given id, or null if not found. |
IConfiguration[] |
getConfigurations()
Returns all of the configurations defined by this project-type. |
java.lang.String |
getDefaultArtifactName()
Returns the default build artifact name for the project |
org.eclipse.core.resources.IResource |
getOwner()
Returns the owner of the managed project (an IProject). |
IProjectType |
getProjectType()
Answers the IProjectType that is the superclass of this
project-type, or null if the attribute was not specified. |
boolean |
isDirty()
Returns true if this project has changes that need to
be saved in the project file, else false . |
boolean |
isValid()
Returns true if this project is valid
else false . |
void |
removeConfiguration(java.lang.String id)
Removes the configuration with the ID specified in the argument. |
void |
setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) |
void |
setValid(boolean isValid)
Sets the element's "Valid" flag. |
void |
updateOwner(org.eclipse.core.resources.IResource resource)
Sets the owner of the managed project. |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObjectPropertiesContainer |
---|
getBuildProperties |
Field Detail |
---|
static final java.lang.String MANAGED_PROJECT_ELEMENT_NAME
static final java.lang.String PROJECTTYPE
static final java.lang.String BUILD_PROPERTIES
static final java.lang.String BUILD_ARTEFACT_TYPE
Method Detail |
---|
IConfiguration createConfiguration(IConfiguration parent, java.lang.String id)
This method performs steps 3 & 4 described above.
parent
- The IConfiguration
to use as a settings templateid
- The unique id the new configuration will have
IConfiguration createConfigurationClone(IConfiguration parent, java.lang.String id)
createConfiguration
method, this method creates a configuration
from an existing configuration in the project.
In this case, the new configuration is cloned from the existing configuration, and does not retain a pointer to the existing configuration.
parent
- The IConfiguration
to cloneid
- The unique id the new configuration will have
void removeConfiguration(java.lang.String id)
id
- The unique id of the configurationIConfiguration[] getConfigurations()
IConfiguration getConfiguration(java.lang.String id)
null
if not found.
id
- The unique id of the configuration
IProjectType getProjectType()
IProjectType
that is the superclass of this
project-type, or null
if the attribute was not specified.
org.eclipse.core.resources.IResource getOwner()
void updateOwner(org.eclipse.core.resources.IResource resource)
resource
- boolean isDirty()
true
if this project has changes that need to
be saved in the project file, else false
.
void setDirty(boolean isDirty)
isDirty
- boolean isValid()
true
if this project is valid
else false
.
void setValid(boolean isValid)
isValid
- java.lang.String getDefaultArtifactName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |