diff options
Diffstat (limited to 'build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java')
-rw-r--r-- | build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java | 115 |
1 files changed, 63 insertions, 52 deletions
diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java index 36304d7e71e..f1101b84aaf 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java @@ -13,13 +13,13 @@ package org.eclipse.cdt.managedbuilder.core; import org.eclipse.core.resources.IResource; /** - * 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 + * 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). - * + * * @since 2.1 * @noextend This class is not intended to be subclassed by clients. * @noimplement This interface is not intended to be implemented by clients. @@ -37,60 +37,63 @@ public interface IResourceConfiguration extends IResourceInfo { public static final String DISABLE_RCBS_TOOL = "disable"; //$NON-NLS-1$ public static final int KIND_DISABLE_RCBS_TOOL = 4; - //TODO: Set name and ID in the constructors to be + //TODO: Set name and ID in the constructors to be // configuration-name#resource-path - + /** * Returns the configuration that is the parent of this resource configuration. - * + * * @return IConfiguration */ + @Override public IConfiguration getParent(); - + /** * Returns whether the resource referenced by this element should be excluded - * from builds of the parent configuration. + * from builds of the parent configuration. * Returns <code>false</code> if the attribute was not specified. - * - * @return boolean + * + * @return boolean */ + @Override public boolean isExcluded(); - + /** - * Returns the path of the project resource that this element references. + * Returns the path of the project resource that this element references. * TODO: What is the format of the path? Absolute? Relative? Canonical? * - * @return String + * @return String */ public String getResourcePath(); - + /** * Returns an integer constant representing the users desire for ordering the application of * a resource custom build step tool. * - * @return int + * @return int */ public int getRcbsApplicability(); - + /** - * Returns the list of tools currently defined for the project resource that + * Returns the list of tools currently defined for the project resource that * this element references. Updates the String attribute toolsToInvoke. * - * @return String + * @return String */ public ITool[] getToolsToInvoke(); - + /** * Sets the new value representing the users desire for ordering the application of * a resource custom build step tool. */ public void setRcbsApplicability(int value); - + /** * Sets the "excluded" flag for the resource. * If <code>true</code>, the project resource identified by the resoursePath * attribute is excluded from the build of the parent configuration. */ + @Override public void setExclude(boolean excluded); /** @@ -99,34 +102,37 @@ public interface IResourceConfiguration extends IResourceInfo { public void setResourcePath(String path); /** - * Returns <code>true</code> if this element has changes that need to + * Returns <code>true</code> if this element has changes that need to * be saved in the project file, else <code>false</code>. - * - * @return boolean + * + * @return boolean */ + @Override public boolean isDirty(); - + /** * Sets the element's "dirty" (have I been modified?) flag. */ + @Override public void setDirty(boolean isDirty); /** * Returns the list of tools associated with this resource configuration. - * + * * @return ITool[] */ + @Override public ITool[] getTools(); /** - * Returns the tool in this resource configuration with the ID specified - * in the argument, or <code>null</code> - * + * Returns the tool in this resource configuration with the ID specified + * in the argument, or <code>null</code> + * * @param id The ID of the requested tool * @return ITool */ public ITool getTool(String id); - + /** * Removes the Tool from the Tool list and map */ @@ -139,83 +145,88 @@ public interface IResourceConfiguration extends IResourceInfo { * @param Id The id for the new tool chain * @param name The name for the new tool chain * @param isExtensionElement Indicates whether this is an extension element or a managed project element - * + * * @return ITool */ public ITool createTool(ITool superClass, String Id, String name, boolean isExtensionElement); /** * Overrides the tool command for a tool defined in this resource configuration's tool. - * + * * @param tool The tool that will have its command modified * @param command The command */ public void setToolCommand(ITool tool, String command); - + /** * Sets the value of a boolean option for this resource configuration. - * + * * @param parent The holder/parent of the option. * @param option The option to change. * @param value The value to apply to the option. - * + * * @return IOption The modified option. This can be the same option or a newly created option. - * + * * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions. * Code assuming ITool as type, will continue to work unchanged. */ - public IOption setOption(IHoldsOptions parent, IOption option, boolean value) - throws BuildException; + @Override + public IOption setOption(IHoldsOptions parent, IOption option, boolean value) + throws BuildException; /** * Sets the value of a string option for this resource configuration. - * + * * @param parent The holder/parent of the option. * @param option The option that will be effected by change. * @param value The value to apply to the option. - * + * * @return IOption The modified option. This can be the same option or a newly created option. - * + * * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions. * Code assuming ITool as type, will continue to work unchanged. */ + @Override public IOption setOption(IHoldsOptions parent, IOption option, String value) throws BuildException; - + /** * Sets the value of a list option for this resource configuration. - * + * * @param parent The holder/parent of the option. * @param option The option to change. * @param value The values to apply to the option. - * + * * @return IOption The modified option. This can be the same option or a newly created option. - * + * * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions. * Code assuming ITool as type, will continue to work unchanged. */ + @Override public IOption setOption(IHoldsOptions parent, IOption option, String[] value) throws BuildException; - + /** * Returns the Eclipse project that owns the resource configuration. - * + * * @return IResource */ public IResource getOwner(); /** * specifies whether the resource configuration is modified and needs rebuild - * + * * @return boolean - */ + */ + @Override public boolean needsRebuild(); /** * sets the resource configuration rebuild state */ + @Override void setRebuildState(boolean rebuild); - + void setTools(ITool[] tools); } |