org.eclipse.cdt.managedbuilder.internal.core
Class AdditionalInput

java.lang.Object
  extended by org.eclipse.cdt.managedbuilder.internal.core.AdditionalInput
All Implemented Interfaces:
IAdditionalInput

public class AdditionalInput
extends java.lang.Object
implements IAdditionalInput


Field Summary
 
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IAdditionalInput
ADDITIONAL_DEPENDENCY, ADDITIONAL_INPUT, ADDITIONAL_INPUT_DEPENDENCY, ADDITIONAL_INPUT_ELEMENT_NAME, KIND, KIND_ADDITIONAL_DEPENDENCY, KIND_ADDITIONAL_INPUT, KIND_ADDITIONAL_INPUT_DEPENDENCY, PATHS
 
Constructor Summary
AdditionalInput(IInputType parent, AdditionalInput additionalInput)
          Create an AdditionalInput based upon an existing AdditionalInput.
AdditionalInput(IInputType parent, org.eclipse.cdt.core.settings.model.ICStorageElement element)
          Create an AdditionalInput based on the specification stored in the project file (.cdtbuild).
AdditionalInput(IInputType parent, IManagedConfigElement element)
          This constructor is called to create an AdditionalInput defined by an extension point in a plugin manifest file, or returned by a dynamic element provider
AdditionalInput(InputType parent, boolean isExtensionElement)
          This constructor is called to create an AdditionalInput whose attributes and children will be added by separate calls.
 
Method Summary
 int getKind()
          Returns the kind of additional input.
 IInputType getParent()
          Returns the InputType parent of this AdditionalInput.
 java.lang.String[] getPaths()
          Returns an array of the relative or absolute paths of the resources to which this element applies.
 boolean isDirty()
          Returns true if this element has changes that need to be saved in the project file, else false.
 boolean isExtensionElement()
           
 boolean needsRebuild()
           
 void resolveReferences()
           
 void serialize(org.eclipse.cdt.core.settings.model.ICStorageElement element)
          Persist the AdditionalInput to the project file.
 void setDirty(boolean isDirty)
          Sets the element's "dirty" (have I been modified?)
 void setKind(int newKind)
          Sets the kind of additional input.
 void setPaths(java.lang.String newPaths)
          Sets semi-colon separated list of the relative or absolute paths of the resources to which this element applies.
 void setRebuildState(boolean rebuild)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AdditionalInput

public AdditionalInput(IInputType parent,
                       IManagedConfigElement element)
This constructor is called to create an AdditionalInput defined by an extension point in a plugin manifest file, or returned by a dynamic element provider

Parameters:
parent - The IInputType parent of this AdditionalInput
element - The AdditionalInput definition from the manifest file or a dynamic element provider

AdditionalInput

public AdditionalInput(InputType parent,
                       boolean isExtensionElement)
This constructor is called to create an AdditionalInput whose attributes and children will be added by separate calls.

Parameters:
InputType - The parent of the an AdditionalInput
boolean - Indicates whether this is an extension element or a managed project element

AdditionalInput

public AdditionalInput(IInputType parent,
                       org.eclipse.cdt.core.settings.model.ICStorageElement element)
Create an AdditionalInput based on the specification stored in the project file (.cdtbuild).

Parameters:
parent - The ITool the AdditionalInput will be added to.
element - The XML element that contains the AdditionalInput settings.

AdditionalInput

public AdditionalInput(IInputType parent,
                       AdditionalInput additionalInput)
Create an AdditionalInput based upon an existing AdditionalInput.

Parameters:
parent - The IInputType the AdditionalInput will be added to.
additionalInput - The existing AdditionalInput to clone.
Method Detail

serialize

public void serialize(org.eclipse.cdt.core.settings.model.ICStorageElement element)
Persist the AdditionalInput to the project file.

Parameters:
doc -
element -

getParent

public IInputType getParent()
Description copied from interface: IAdditionalInput
Returns the InputType parent of this AdditionalInput.

Specified by:
getParent in interface IAdditionalInput
Returns:
IInputType

getPaths

public java.lang.String[] getPaths()
Description copied from interface: IAdditionalInput
Returns an array of the relative or absolute paths of the resources to which this element applies. The resources must be a member of the project, the output from another tool in the tool-chain, or an external file. The file name of the path can use GNU Make pattern rule syntax (in order to generate the name from the input file name).

Specified by:
getPaths in interface IAdditionalInput
Returns:
String[]

setPaths

public void setPaths(java.lang.String newPaths)
Description copied from interface: IAdditionalInput
Sets semi-colon separated list of the relative or absolute paths of the resources to which this element applies.

Specified by:
setPaths in interface IAdditionalInput

getKind

public int getKind()
Description copied from interface: IAdditionalInput
Returns the kind of additional input. The valid values are: KIND_ADDITIONAL_DEPENDENCY - added as a tool dependency, but not to the command line. KIND_ADDITIONAL_INPUT - added as an additional input to the command line, but not as a dependency. KIND_ADDITIONAL_INPUT_DEPENDENCY - added as both. The default is KIND_ADDITIONAL_INPUT_DEPENDENCY

Specified by:
getKind in interface IAdditionalInput

setKind

public void setKind(int newKind)
Description copied from interface: IAdditionalInput
Sets the kind of additional input.

Specified by:
setKind in interface IAdditionalInput

isExtensionElement

public boolean isExtensionElement()

isDirty

public boolean isDirty()
Description copied from interface: IAdditionalInput
Returns true if this element has changes that need to be saved in the project file, else false.

Specified by:
isDirty in interface IAdditionalInput
Returns:
boolean

setDirty

public void setDirty(boolean isDirty)
Description copied from interface: IAdditionalInput
Sets the element's "dirty" (have I been modified?) flag.

Specified by:
setDirty in interface IAdditionalInput

resolveReferences

public void resolveReferences()

needsRebuild

public boolean needsRebuild()

setRebuildState

public void setRebuildState(boolean rebuild)