|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IResourceConfiguration
This class is a place to define build attributes of individual resources that are different from the configuration as a whole. The resourceConfiguration element can have multiple tool children. They define the tool(s) to be used to build the specified resource. The tool(s) can execute before, after, or instead of the default tool for the resources (see the toolOrder attribute in the tool element).
Field Summary | |
---|---|
static java.lang.String |
APPLY_RCBS_TOOL_AFTER
|
static java.lang.String |
APPLY_RCBS_TOOL_AS_OVERRIDE
|
static java.lang.String |
APPLY_RCBS_TOOL_BEFORE
|
static java.lang.String |
DISABLE_RCBS_TOOL
|
static int |
KIND_APPLY_RCBS_TOOL_AFTER
|
static int |
KIND_APPLY_RCBS_TOOL_AS_OVERRIDE
|
static int |
KIND_APPLY_RCBS_TOOL_BEFORE
|
static int |
KIND_DISABLE_RCBS_TOOL
|
static java.lang.String |
RCBS_APPLICABILITY
|
static java.lang.String |
RESOURCE_CONFIGURATION_ELEMENT_NAME
|
static java.lang.String |
TOOLS_TO_INVOKE
|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IResourceInfo |
---|
EXCLUDE, RESOURCE_PATH |
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Method Summary | |
---|---|
ITool |
createTool(ITool superClass,
java.lang.String Id,
java.lang.String name,
boolean isExtensionElement)
Creates a Tool child for this resource configuration. |
org.eclipse.core.resources.IResource |
getOwner()
Returns the Eclipse project that owns the resource configuration. |
IConfiguration |
getParent()
Returns the configuration that is the parent of this resource configuration. |
int |
getRcbsApplicability()
Returns an integer constant representing the users desire for ordering the application of a resource custom build step tool. |
java.lang.String |
getResourcePath()
Returns the path of the project resource that this element references. |
ITool |
getTool(java.lang.String id)
Returns the tool in this resource configuration with the ID specified in the argument, or null |
ITool[] |
getTools()
Returns the list of tools associated with this resource configuration. |
ITool[] |
getToolsToInvoke()
Returns the list of tools currently defined for the project resource that this element references. |
boolean |
isDirty()
Returns true if this element has changes that need to
be saved in the project file, else false . |
boolean |
isExcluded()
Returns whether the resource referenced by this element should be excluded from builds of the parent configuration. |
boolean |
needsRebuild()
specifies whether the resource configuration is modified and needs rebuild |
void |
removeTool(ITool tool)
Removes the Tool from the Tool list and map |
void |
setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) |
void |
setExclude(boolean excluded)
Sets the "excluded" flag for the resource. |
IOption |
setOption(IHoldsOptions parent,
IOption option,
boolean value)
Sets the value of a boolean option for this resource configuration. |
IOption |
setOption(IHoldsOptions parent,
IOption option,
java.lang.String value)
Sets the value of a string option for this resource configuration. |
IOption |
setOption(IHoldsOptions parent,
IOption option,
java.lang.String[] value)
Sets the value of a list option for this resource configuration. |
void |
setRcbsApplicability(int value)
Sets the new value representing the users desire for ordering the application of a resource custom build step tool. |
void |
setRebuildState(boolean rebuild)
sets the resource configuration rebuild state |
void |
setResourcePath(java.lang.String path)
Sets the resource path to which this resource configuration applies. |
void |
setToolCommand(ITool tool,
java.lang.String command)
Overrides the tool command for a tool defined in this resource configuration's tool. |
void |
setTools(ITool[] tools)
|
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IResourceInfo |
---|
canExclude, getCLanguageDatas, getKind, getPath, getResourceData, isExtensionElement, isValid, setOption, setPath, supportsBuild |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion |
Field Detail |
---|
static final java.lang.String RESOURCE_CONFIGURATION_ELEMENT_NAME
static final java.lang.String RCBS_APPLICABILITY
static final java.lang.String TOOLS_TO_INVOKE
static final java.lang.String APPLY_RCBS_TOOL_AS_OVERRIDE
static final int KIND_APPLY_RCBS_TOOL_AS_OVERRIDE
static final java.lang.String APPLY_RCBS_TOOL_BEFORE
static final int KIND_APPLY_RCBS_TOOL_BEFORE
static final java.lang.String APPLY_RCBS_TOOL_AFTER
static final int KIND_APPLY_RCBS_TOOL_AFTER
static final java.lang.String DISABLE_RCBS_TOOL
static final int KIND_DISABLE_RCBS_TOOL
Method Detail |
---|
IConfiguration getParent()
getParent
in interface IResourceInfo
boolean isExcluded()
false
if the attribute was not specified.
isExcluded
in interface IResourceInfo
java.lang.String getResourcePath()
int getRcbsApplicability()
ITool[] getToolsToInvoke()
void setRcbsApplicability(int value)
int
- void setExclude(boolean excluded)
true
, the project resource identified by the resoursePath
attribute is excluded from the build of the parent configuration.
setExclude
in interface IResourceInfo
boolean
- void setResourcePath(java.lang.String path)
boolean isDirty()
true
if this element has changes that need to
be saved in the project file, else false
.
isDirty
in interface IResourceInfo
void setDirty(boolean isDirty)
setDirty
in interface IResourceInfo
isDirty
- ITool[] getTools()
getTools
in interface IResourceInfo
ITool getTool(java.lang.String id)
null
id
- The ID of the requested tool
void removeTool(ITool tool)
Tool
- ITool createTool(ITool superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
Tool
child for this resource configuration.
ITool
- The superClass, if anyString
- The id for the new tool chainString
- The name for the new tool chainboolean
- Indicates whether this is an extension element or a managed project element
void setToolCommand(ITool tool, java.lang.String command)
tool
- The tool that will have its command modifiedcommand
- The commandIOption setOption(IHoldsOptions parent, IOption option, boolean value) throws BuildException
setOption
in interface IResourceInfo
parent
- The holder/parent of the option.option
- The option to change.value
- The value to apply to the option.
BuildException
IOption setOption(IHoldsOptions parent, IOption option, java.lang.String value) throws BuildException
setOption
in interface IResourceInfo
parent
- The holder/parent of the option.option
- The option that will be effected by change.value
- The value to apply to the option.
BuildException
IOption setOption(IHoldsOptions parent, IOption option, java.lang.String[] value) throws BuildException
setOption
in interface IResourceInfo
parent
- The holder/parent of the option.option
- The option to change.value
- The values to apply to the option.
BuildException
org.eclipse.core.resources.IResource getOwner()
boolean needsRebuild()
needsRebuild
in interface IResourceInfo
void setRebuildState(boolean rebuild)
setRebuildState
in interface IResourceInfo
rebuild
- void setTools(ITool[] tools)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |