public interface IBuildConfiguration extends IAdaptable
All projects have at least one build configuration. By default this
has name DEFAULT_CONFIG_NAME
. One configuration in the project is defined
to be 'active'. The active configuration is built by default. If unset, the
active configuration defaults to the first configuration in the project.
Build configurations are created and set on the project description using:
IProjectDescription.setBuildConfigs(String[])
.
Build configurations set on Projects must have unique non-null names.
When a project is built, a specific configuration is built. This configuration is passed to the builders so they can adapt their behavior appropriately. Builders which don't care about configurations may ignore this, and work as before.
Build configuration can reference other builds configurations. These references are created
using IWorkspace.newBuildConfig(String, String)
, and set on the referencing project
with IProjectDescription.setBuildConfigReferences(String, IBuildConfiguration[])
.
A referenced build configuration may have a null
configuration name which is resolved to the
referenced project's current active build configuration at build time.
Workspace build will ensure that the projects are built in an appropriate order as defined by the reference graph.
IWorkspace.newBuildConfig(String, String)
,
IProjectDescription.setActiveBuildConfig(String)
,
IProjectDescription.setBuildConfigs(String[])
,
IProjectDescription.setBuildConfigReferences(String, IBuildConfiguration[])
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_CONFIG_NAME
The Id of the default build configuration
|
Modifier and Type | Method and Description |
---|---|
String |
getName()
Returns the human readable name of this build configuration.
|
IProject |
getProject() |
getAdapter
static final String DEFAULT_CONFIG_NAME
IProject getProject()
String getName()
IBuildConfiguration
is set on a Project, this can never be null.
If this IBuildConfiguration is being used as a reference to a build configuration in another project, this may be null. Such build configuration references are resolved to the current active configuration at build time.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.