org.eclipse.cdt.managedbuilder.core
Interface IConfigurationV2

All Superinterfaces:
IBuildObject
All Known Implementing Classes:
ConfigurationV2

public interface IConfigurationV2
extends IBuildObject

This class represents a project configuration in the old (CDT 2.0) managed build system model.

The configuration contains one or more children of type tool-reference. This class was deprecated in 2.1


Field Summary
static java.lang.String CONFIGURATION_ELEMENT_NAME
           
static java.lang.String PARENT
           
static java.lang.String TOOLREF_ELEMENT_NAME
           
 
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject
ID, NAME
 
Method Summary
 IConfiguration getCreatedConfig()
          Returns the configuration that was created from this V2.0 configuration.
 ITool[] getFilteredTools(org.eclipse.core.resources.IProject project)
          Projects have C or CC natures.
 org.eclipse.core.resources.IResource getOwner()
          Returns the resource that owns the project that owns the configuration.
 IConfigurationV2 getParent()
          Answers the configuration that this configuration is based on.
 ITarget getTarget()
          Returns the target for this configuration.
 ITool getToolById(java.lang.String id)
          Answers the ITool in the receiver with the same id as the argument, or null.
 IToolReference[] getToolReferences()
          Returns the tool references that are children of this configuration.
 ITool[] getTools()
          Returns the tools that are used in this configuration.
 boolean isDirty()
          Answers true the receiver has changes that need to be saved in the project file, else false.
 boolean needsRebuild()
          Answers whether the receiver has been changed and requires the project to be rebuilt.
 void setCreatedConfig(IConfiguration config)
          Sets the configuration that was created from this V2.0 configuration.
 void setDirty(boolean isDirty)
          Sets the element's "dirty" (have I been modified?)
 void setName(java.lang.String name)
          Sets the name of the receiver to the value specified in the argument
 void setOption(IOption option, boolean value)
          Sets the value of a boolean option for this configuration.
 void setOption(IOption option, java.lang.String value)
          Sets the value of a string option for this configuration.
 void setOption(IOption option, java.lang.String[] value)
          Sets the value of a list option for this configuration.
 void setRebuildState(boolean rebuild)
          Sets the rebuild state in the receiver.
 void setToolCommand(ITool tool, java.lang.String command)
          Overrides the tool command for a tool defined in the receiver.
 
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion
 

Field Detail

CONFIGURATION_ELEMENT_NAME

static final java.lang.String CONFIGURATION_ELEMENT_NAME
See Also:
Constant Field Values

TOOLREF_ELEMENT_NAME

static final java.lang.String TOOLREF_ELEMENT_NAME
See Also:
Constant Field Values

PARENT

static final java.lang.String PARENT
See Also:
Constant Field Values
Method Detail

getFilteredTools

ITool[] getFilteredTools(org.eclipse.core.resources.IProject project)
Projects have C or CC natures. Tools can specify a filter so they are not misapplied to a project. This method allows the caller to retrieve a list of tools from a project that are correct for a project's nature.

Parameters:
project - the project to filter for
Returns:
an array of ITools that have compatible filters for the specified project

getOwner

org.eclipse.core.resources.IResource getOwner()
Returns the resource that owns the project that owns the configuration.

Returns:

getParent

IConfigurationV2 getParent()
Answers the configuration that this configuration is based on.

Returns:

getTarget

ITarget getTarget()
Returns the target for this configuration.

Returns:

getToolById

ITool getToolById(java.lang.String id)
Answers the ITool in the receiver with the same id as the argument, or null.

Parameters:
id - unique identifier to search for
Returns:
ITool

getTools

ITool[] getTools()
Returns the tools that are used in this configuration.

Returns:
ITool[]

getToolReferences

IToolReference[] getToolReferences()
Returns the tool references that are children of this configuration.

Returns:

isDirty

boolean isDirty()
Answers true the receiver has changes that need to be saved in the project file, else false.

Returns:
boolean

needsRebuild

boolean needsRebuild()
Answers whether the receiver has been changed and requires the project to be rebuilt.

Returns:
true if the receiver contains a change that needs the project to be rebuilt

setDirty

void setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) flag.

Parameters:
isDirty -

setName

void setName(java.lang.String name)
Sets the name of the receiver to the value specified in the argument

Parameters:
name -

setOption

void setOption(IOption option,
               boolean value)
               throws BuildException
Sets the value of a boolean option for this configuration.

Parameters:
option - The option to change.
value - The value to apply to the option.
Throws:
BuildException

setOption

void setOption(IOption option,
               java.lang.String value)
               throws BuildException
Sets the value of a string option for this configuration.

Parameters:
option - The option that will be effected by change.
value - The value to apply to the option.
Throws:
BuildException

setOption

void setOption(IOption option,
               java.lang.String[] value)
               throws BuildException
Sets the value of a list option for this configuration.

Parameters:
option - The option to change.
value - The values to apply to the option.
Throws:
BuildException

setRebuildState

void setRebuildState(boolean rebuild)
Sets the rebuild state in the receiver.

Parameters:
rebuild - true will force a rebuild the next time the project builds
See Also:
IManagedBuildInfo.setRebuildState(boolean)

setToolCommand

void setToolCommand(ITool tool,
                    java.lang.String command)
Overrides the tool command for a tool defined in the receiver.

Parameters:
tool - The tool that will have its command modified
command - The command

setCreatedConfig

void setCreatedConfig(IConfiguration config)
Sets the configuration that was created from this V2.0 configuration.

Parameters:
config -

getCreatedConfig

IConfiguration getCreatedConfig()
Returns the configuration that was created from this V2.0 configuration.

Returns:
IConfiguration