|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.cdt.managedbuilder.internal.core.BuildObject
org.eclipse.cdt.managedbuilder.internal.core.InputType
public class InputType
Field Summary |
---|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IInputType |
---|
ASSIGN_TO_OPTION, BUILD_VARIABLE, DEPENDENCY_CONTENT_TYPE, DEPENDENCY_EXTENSIONS, HEADER_CONTENT_TYPE, HEADERS, INPUT_TYPE_ELEMENT_NAME, LANGUAGE_ID, LANGUAGE_INFO_CALCULATOR, LANGUAGE_NAME, MULTIPLE_OF_TYPE, OPTION, PRIMARY_INPUT, SCANNER_CONFIG_PROFILE_ID, SOURCE_CONTENT_TYPE, SOURCES |
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Constructor Summary | |
---|---|
InputType(ITool parent,
org.eclipse.cdt.core.settings.model.ICStorageElement element)
Create an InputType based on the specification stored in the
project file (.cdtbuild). |
|
InputType(ITool parent,
IManagedConfigElement element)
This constructor is called to create an InputType defined by an extension point in a plugin manifest file, or returned by a dynamic element provider |
|
InputType(ITool parent,
java.lang.String Id,
java.lang.String name,
InputType inputType)
Create an InputType based upon an existing InputType. |
|
InputType(Tool parent,
IInputType superClass,
java.lang.String Id,
java.lang.String name,
boolean isExtensionElement)
This constructor is called to create an InputType whose attributes and children will be added by separate calls. |
Method Summary | |
---|---|
IAdditionalInput |
createAdditionalInput(java.lang.String paths)
Creates an additionalInput child for this InputType. |
IInputOrder |
createInputOrder(java.lang.String path)
Creates an inputOrder child for this InputType. |
org.eclipse.core.runtime.IPath[] |
getAdditionalDependencies()
Returns all of the additional dependency resources of this InputType. |
IAdditionalInput |
getAdditionalInput(java.lang.String paths)
Returns the AdditionalInput element with the path specified in the argument. |
IAdditionalInput[] |
getAdditionalInputs()
Returns all of the AdditionalInput children of this InputType |
org.eclipse.core.runtime.IPath[] |
getAdditionalResources()
Returns all of the additional input resources of this InputType. |
java.lang.String |
getAssignToOptionId()
Returns the id of the option whose value is to be assigned to the file(s) calculated for this input type. |
BooleanExpressionApplicabilityCalculator |
getBooleanExpressionCalculator()
|
java.lang.String |
getBuildVariable()
Returns the name of the build variable associated this this input type's resources The build variable used in the build file to represent the list of input files when multipleOfType is True. |
org.eclipse.core.runtime.content.IContentType |
getDependencyContentType()
Returns the Eclipse IContentType that describes the
dependency files of this input type. |
java.lang.String[] |
getDependencyExtensions(ITool tool)
Returns the list of valid dependency extensions for this input type. |
java.lang.String[] |
getDependencyExtensionsAttribute()
Returns the list of valid dependency extensions from the dependencyExtensions attribute. |
IManagedDependencyGeneratorType |
getDependencyGenerator()
Returns a class instance that implements an interface to generate source-level dependencies for this input type. |
org.eclipse.core.runtime.IConfigurationElement |
getDependencyGeneratorElement()
|
java.lang.String |
getDiscoveryProfileId(ITool tool)
|
java.lang.String |
getDiscoveryProfileIdAttribute()
|
java.lang.String[] |
getHeaderContentTypeIds()
|
org.eclipse.core.runtime.content.IContentType[] |
getHeaderContentTypes()
|
java.lang.String[] |
getHeaderExtensions(ITool tool)
|
java.lang.String[] |
getHeaderExtensionsAttribute()
|
IInputOrder |
getInputOrder(java.lang.String path)
Returns the InputOrder element with the path specified in the argument. |
IInputOrder[] |
getInputOrders()
Returns all of the InputOrder children of this InputType |
java.lang.String |
getLanguageId(ITool tool)
|
java.lang.String |
getLanguageIdAttribute()
|
java.lang.String |
getLanguageName(ITool tool)
|
java.lang.String |
getLanguageNameAttribute()
|
java.lang.String |
getManagedBuildRevision()
|
boolean |
getMultipleOfType()
Returns true if this inputType can contain multiple input
resources, else false . |
java.lang.String |
getName()
|
java.lang.String |
getOptionId()
Returns the id of the option that is associated with this input type on the command line. |
ITool |
getParent()
Returns the tool parent of this InputType. |
boolean |
getPrimaryInput()
Returns true if this inputType is considered the primary input
of the tool, else false . |
IResourceInfo |
getRcInfo(ITool tool)
|
org.eclipse.core.runtime.content.IContentType |
getSourceContentType()
Returns the Eclipse IContentType that describes this
input type. |
java.lang.String[] |
getSourceContentTypeIds()
|
org.eclipse.core.runtime.content.IContentType[] |
getSourceContentTypes()
|
java.lang.String[] |
getSourceExtensions(ITool tool)
Returns the list of valid source extensions for this input type. |
java.lang.String[] |
getSourceExtensions(ITool tool,
org.eclipse.core.resources.IProject project)
|
java.lang.String[] |
getSourceExtensionsAttribute()
Returns the list of valid source extensions from the sourceExtensions attribute. |
IInputType |
getSuperClass()
Returns the IInputType that is the superclass of this
InputType, or null if the attribute was not specified. |
org.eclipse.core.runtime.PluginVersionIdentifier |
getVersion()
|
boolean |
hasCustomSettings()
|
boolean |
hasScannerConfigSettings()
|
boolean |
isDependencyExtension(ITool tool,
java.lang.String ext)
Answers true if the input type considers the file extension to be
one associated with a dependency file. |
boolean |
isDirty()
Returns true if this element has changes that need to
be saved in the project file, else false . |
boolean |
isEnabled(ITool tool)
|
boolean |
isExtensionElement()
Returns true if this InputType was loaded from a manifest file,
and false if it was loaded from a project (.cdtbuild) file. |
boolean |
isSourceExtension(ITool tool,
java.lang.String ext)
Answers true if the input type considers the file extension to be
one associated with a source file. |
boolean |
needsRebuild()
|
void |
removeAdditionalInput(IAdditionalInput element)
Removes the AdditionalInput element specified in the argument. |
void |
removeAdditionalInput(java.lang.String path)
Removes the AdditionalInput element with the path specified in the argument. |
void |
removeInputOrder(IInputOrder element)
Removes the InputOrder element specified in the argument. |
void |
removeInputOrder(java.lang.String path)
Removes the InputOrder element with the path specified in the argument. |
void |
resolveReferences()
|
void |
serialize(org.eclipse.cdt.core.settings.model.ICStorageElement element)
Persist the InputType to the project file. |
void |
setAssignToOptionId(java.lang.String id)
Sets the id of the option whose value is to be assigned to the file(s) calculated for this input type. |
void |
setBuildVariable(java.lang.String variableName)
Sets the name of the build variable associated this this input type's resources |
void |
setDependencyContentType(org.eclipse.core.runtime.content.IContentType type)
Sets the Eclipse IContentType that describes the
dependency files of this input type. |
void |
setDependencyExtensionsAttribute(java.lang.String extensions)
Sets the list of valid dependency extensions for this input type. |
void |
setDependencyGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
|
void |
setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) |
void |
setHeaderContentTypeIds(java.lang.String[] ids)
|
void |
setHeaderExtensionsAttribute(java.lang.String[] extensions)
|
void |
setLanguageIdAttribute(java.lang.String id)
|
void |
setLanguageNameAttribute(java.lang.String name)
|
void |
setMultipleOfType(boolean b)
Sets whether this inputType can contain multiple input resources |
void |
setOptionId(java.lang.String id)
Sets the id of the option that is associated with this input type on the command line. |
void |
setPrimaryInput(boolean b)
Sets whether this inputType is considered the primary input of the tool |
void |
setRebuildState(boolean rebuild)
|
void |
setSourceContentType(org.eclipse.core.runtime.content.IContentType type)
Sets the Eclipse IContentType that describes this
input type. |
void |
setSourceContentTypeIds(java.lang.String[] ids)
|
void |
setSourceContentTypes(org.eclipse.core.runtime.content.IContentType[] types)
|
void |
setSourceExtensionsAttribute(java.lang.String extensions)
Sets the list of valid source extensions for this input type. |
void |
setSourceExtensionsAttribute(java.lang.String[] extensions)
|
void |
setVersion(org.eclipse.core.runtime.PluginVersionIdentifier version)
|
Methods inherited from class org.eclipse.cdt.managedbuilder.internal.core.BuildObject |
---|
getBaseId, getId, getVersionFromId, setId, setManagedBuildRevision, setName, toString, updateManagedBuildRevision |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
getBaseId, getId |
Constructor Detail |
---|
public InputType(ITool parent, IManagedConfigElement element)
parent
- The ITool parent of this InputTypeelement
- The InputType definition from the manifest file or a dynamic element
providerpublic InputType(Tool parent, IInputType superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
Tool
- The parent of the an InputTypeInputType
- The superClass, if anyString
- The id for the new InputTypeString
- The name for the new InputTypeboolean
- Indicates whether this is an extension element or a managed project elementpublic InputType(ITool parent, org.eclipse.cdt.core.settings.model.ICStorageElement element)
InputType
based on the specification stored in the
project file (.cdtbuild).
parent
- The ITool
the InputType will be added to.element
- The XML element that contains the InputType settings.public InputType(ITool parent, java.lang.String Id, java.lang.String name, InputType inputType)
InputType
based upon an existing InputType.
parent
- The ITool
the InputType will be added to.Id
- The identifier of the new InputTypename
- The name of the new InputTypeinputType
- The existing InputType to clone.Method Detail |
---|
public void serialize(org.eclipse.cdt.core.settings.model.ICStorageElement element)
doc
- element
- public ITool getParent()
IInputType
getParent
in interface IInputType
public IInputOrder createInputOrder(java.lang.String path)
IInputType
createInputOrder
in interface IInputType
path
- The path associated with the InputOrder element
public IInputOrder[] getInputOrders()
IInputType
getInputOrders
in interface IInputType
public IInputOrder getInputOrder(java.lang.String path)
IInputType
getInputOrder
in interface IInputType
path
- The path associated with the InputOrder element
public void removeInputOrder(java.lang.String path)
IInputType
removeInputOrder
in interface IInputType
path
- The path associated with the InputOrder elementpublic void removeInputOrder(IInputOrder element)
IInputType
removeInputOrder
in interface IInputType
public IAdditionalInput createAdditionalInput(java.lang.String paths)
IInputType
createAdditionalInput
in interface IInputType
paths
- The path associated with the AdditionalInput element
public IAdditionalInput[] getAdditionalInputs()
IInputType
getAdditionalInputs
in interface IInputType
public IAdditionalInput getAdditionalInput(java.lang.String paths)
IInputType
getAdditionalInput
in interface IInputType
paths
- The path associated with the AdditionalInput element
public void removeAdditionalInput(java.lang.String path)
IInputType
removeAdditionalInput
in interface IInputType
path
- The path associated with the AdditionalInput elementpublic void removeAdditionalInput(IAdditionalInput element)
IInputType
removeAdditionalInput
in interface IInputType
element
- The AdditionalInput elementpublic org.eclipse.core.runtime.IPath[] getAdditionalDependencies()
IInputType
getAdditionalDependencies
in interface IInputType
public org.eclipse.core.runtime.IPath[] getAdditionalResources()
IInputType
getAdditionalResources
in interface IInputType
public IInputType getSuperClass()
IInputType
IInputType
that is the superclass of this
InputType, or null
if the attribute was not specified.
getSuperClass
in interface IInputType
public java.lang.String getName()
getName
in interface IBuildObject
getName
in class BuildObject
public java.lang.String getBuildVariable()
IInputType
getBuildVariable
in interface IInputType
public void setBuildVariable(java.lang.String variableName)
IInputType
setBuildVariable
in interface IInputType
public org.eclipse.core.runtime.content.IContentType getDependencyContentType()
IInputType
IContentType
that describes the
dependency files of this input type. If both the dependencyExtensions
attribute and the dependencyContentType attribute are specified,
the dependencyContentType will be used if it is defined in Eclipse.
getDependencyContentType
in interface IInputType
public void setDependencyContentType(org.eclipse.core.runtime.content.IContentType type)
IInputType
IContentType
that describes the
dependency files of this input type.
setDependencyContentType
in interface IInputType
public java.lang.String[] getDependencyExtensionsAttribute()
IInputType
getDependencyExtensionsAttribute
in interface IInputType
public void setDependencyExtensionsAttribute(java.lang.String extensions)
IInputType
setDependencyExtensionsAttribute
in interface IInputType
extensions
- The comma-separated list of valid dependency extensions
- not including the separator period.public java.lang.String[] getDependencyExtensions(ITool tool)
IInputType
getDependencyExtensions
in interface IInputType
tool
- the tool that contains the input-type
public boolean isDependencyExtension(ITool tool, java.lang.String ext)
IInputType
true
if the input type considers the file extension to be
one associated with a dependency file.
isDependencyExtension
in interface IInputType
tool
- the tool that contains the input-typeext
- file extension of the source
public IManagedDependencyGeneratorType getDependencyGenerator()
IInputType
null
in which case, the receiver
should assume that the input type does not require dependency information
when the project is built.
getDependencyGenerator
in interface IInputType
public org.eclipse.core.runtime.IConfigurationElement getDependencyGeneratorElement()
public void setDependencyGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
public boolean getMultipleOfType()
IInputType
true
if this inputType can contain multiple input
resources, else false
. The inputs can be project resources,
or the outputs of other tools in the tool-chain.
getMultipleOfType
in interface IInputType
public void setMultipleOfType(boolean b)
IInputType
setMultipleOfType
in interface IInputType
public boolean getPrimaryInput()
IInputType
true
if this inputType is considered the primary input
of the tool, else false
.
getPrimaryInput
in interface IInputType
public void setPrimaryInput(boolean b)
IInputType
setPrimaryInput
in interface IInputType
public java.lang.String getOptionId()
IInputType
getOptionId
in interface IInputType
public void setOptionId(java.lang.String id)
IInputType
setOptionId
in interface IInputType
public java.lang.String getAssignToOptionId()
IInputType
getAssignToOptionId
in interface IInputType
public void setAssignToOptionId(java.lang.String id)
IInputType
setAssignToOptionId
in interface IInputType
public org.eclipse.core.runtime.content.IContentType getSourceContentType()
IInputType
IContentType
that describes this
input type. If both the sources attribute and the sourceContentType
attribute are specified, the sourceContentType will be used if it
is registered in Eclipse.
getSourceContentType
in interface IInputType
public org.eclipse.core.runtime.content.IContentType[] getSourceContentTypes()
getSourceContentTypes
in interface IInputType
public org.eclipse.core.runtime.content.IContentType[] getHeaderContentTypes()
getHeaderContentTypes
in interface IInputType
public java.lang.String[] getHeaderExtensionsAttribute()
getHeaderExtensionsAttribute
in interface IInputType
public java.lang.String[] getHeaderContentTypeIds()
getHeaderContentTypeIds
in interface IInputType
public java.lang.String[] getSourceContentTypeIds()
getSourceContentTypeIds
in interface IInputType
public void setHeaderContentTypeIds(java.lang.String[] ids)
setHeaderContentTypeIds
in interface IInputType
public void setHeaderExtensionsAttribute(java.lang.String[] extensions)
setHeaderExtensionsAttribute
in interface IInputType
public void setSourceContentTypeIds(java.lang.String[] ids)
setSourceContentTypeIds
in interface IInputType
public void setSourceExtensionsAttribute(java.lang.String[] extensions)
setSourceExtensionsAttribute
in interface IInputType
public void setSourceContentType(org.eclipse.core.runtime.content.IContentType type)
IInputType
IContentType
that describes this
input type.
setSourceContentType
in interface IInputType
type
- The Eclipse content typepublic void setSourceContentTypes(org.eclipse.core.runtime.content.IContentType[] types)
public java.lang.String[] getSourceExtensionsAttribute()
IInputType
getSourceExtensionsAttribute
in interface IInputType
public void setSourceExtensionsAttribute(java.lang.String extensions)
IInputType
setSourceExtensionsAttribute
in interface IInputType
extensions
- The comma-separated list of valid file extensions
- not including the separator period.public java.lang.String[] getSourceExtensions(ITool tool)
IInputType
getSourceExtensions
in interface IInputType
tool
- the tool that contains the input-type
public java.lang.String[] getSourceExtensions(ITool tool, org.eclipse.core.resources.IProject project)
public java.lang.String[] getHeaderExtensions(ITool tool)
getHeaderExtensions
in interface IInputType
public boolean isSourceExtension(ITool tool, java.lang.String ext)
IInputType
true
if the input type considers the file extension to be
one associated with a source file.
isSourceExtension
in interface IInputType
tool
- the tool that contains the input-typeext
- file extension of the source
public boolean isExtensionElement()
IInputType
true
if this InputType was loaded from a manifest file,
and false
if it was loaded from a project (.cdtbuild) file.
isExtensionElement
in interface IInputType
public boolean isDirty()
IInputType
true
if this element has changes that need to
be saved in the project file, else false
.
isDirty
in interface IInputType
public void setDirty(boolean isDirty)
IInputType
setDirty
in interface IInputType
public void resolveReferences()
public java.lang.String getManagedBuildRevision()
getManagedBuildRevision
in interface IBuildObject
getManagedBuildRevision
in class BuildObject
public org.eclipse.core.runtime.PluginVersionIdentifier getVersion()
getVersion
in interface IBuildObject
getVersion
in class BuildObject
public void setVersion(org.eclipse.core.runtime.PluginVersionIdentifier version)
setVersion
in interface IBuildObject
setVersion
in class BuildObject
version
- The version to set.public boolean needsRebuild()
public void setRebuildState(boolean rebuild)
public IResourceInfo getRcInfo(ITool tool)
public java.lang.String getLanguageIdAttribute()
public java.lang.String getLanguageNameAttribute()
public java.lang.String getLanguageId(ITool tool)
getLanguageId
in interface IInputType
public java.lang.String getLanguageName(ITool tool)
getLanguageName
in interface IInputType
public java.lang.String getDiscoveryProfileId(ITool tool)
getDiscoveryProfileId
in interface IInputType
public java.lang.String getDiscoveryProfileIdAttribute()
public void setLanguageIdAttribute(java.lang.String id)
setLanguageIdAttribute
in interface IInputType
public void setLanguageNameAttribute(java.lang.String name)
setLanguageNameAttribute
in interface IInputType
public BooleanExpressionApplicabilityCalculator getBooleanExpressionCalculator()
public boolean isEnabled(ITool tool)
public boolean hasScannerConfigSettings()
public boolean hasCustomSettings()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |