|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IInputType
This interface represents an inputType instance in the managed build system. It describes one category of input files to a Tool. A tool can have multiple inputType children.
Field Summary | |
---|---|
static java.lang.String |
ASSIGN_TO_OPTION
|
static java.lang.String |
BUILD_VARIABLE
|
static java.lang.String |
DEPENDENCY_CONTENT_TYPE
|
static java.lang.String |
DEPENDENCY_EXTENSIONS
|
static java.lang.String |
HEADER_CONTENT_TYPE
|
static java.lang.String |
HEADERS
|
static java.lang.String |
INPUT_TYPE_ELEMENT_NAME
|
static java.lang.String |
LANGUAGE_ID
|
static java.lang.String |
LANGUAGE_INFO_CALCULATOR
|
static java.lang.String |
LANGUAGE_NAME
|
static java.lang.String |
MULTIPLE_OF_TYPE
|
static java.lang.String |
OPTION
|
static java.lang.String |
PRIMARY_INPUT
|
static java.lang.String |
SCANNER_CONFIG_PROFILE_ID
|
static java.lang.String |
SOURCE_CONTENT_TYPE
|
static java.lang.String |
SOURCES
|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Method Summary | |
---|---|
IAdditionalInput |
createAdditionalInput(java.lang.String path)
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 path)
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. |
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. |
java.lang.String |
getDiscoveryProfileId(ITool tool)
|
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 |
getLanguageName(ITool tool)
|
boolean |
getMultipleOfType()
Returns true if this inputType can contain multiple input
resources, else false . |
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 . |
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[] |
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. |
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 |
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. |
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 |
setAssignToOptionId(java.lang.String optionId)
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 |
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 multiple)
Sets whether this inputType can contain multiple input resources |
void |
setOptionId(java.lang.String optionId)
Sets the id of the option that is associated with this input type on the command line. |
void |
setPrimaryInput(boolean primary)
Sets whether this inputType is considered the primary input of the tool |
void |
setSourceContentType(org.eclipse.core.runtime.content.IContentType contentType)
Sets the Eclipse IContentType that describes this
input type. |
void |
setSourceContentTypeIds(java.lang.String[] ids)
|
void |
setSourceExtensionsAttribute(java.lang.String extensions)
Sets the list of valid source extensions for this input type. |
void |
setSourceExtensionsAttribute(java.lang.String[] extensions)
|
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion |
Field Detail |
---|
static final java.lang.String INPUT_TYPE_ELEMENT_NAME
static final java.lang.String SOURCE_CONTENT_TYPE
static final java.lang.String HEADER_CONTENT_TYPE
static final java.lang.String SOURCES
static final java.lang.String HEADERS
static final java.lang.String DEPENDENCY_CONTENT_TYPE
static final java.lang.String DEPENDENCY_EXTENSIONS
static final java.lang.String OPTION
static final java.lang.String ASSIGN_TO_OPTION
static final java.lang.String MULTIPLE_OF_TYPE
static final java.lang.String PRIMARY_INPUT
static final java.lang.String BUILD_VARIABLE
static final java.lang.String LANGUAGE_ID
static final java.lang.String LANGUAGE_NAME
static final java.lang.String LANGUAGE_INFO_CALCULATOR
static final java.lang.String SCANNER_CONFIG_PROFILE_ID
Method Detail |
---|
IInputOrder createInputOrder(java.lang.String path)
path
- The path associated with the InputOrder element
void removeInputOrder(java.lang.String path)
path
- The path associated with the InputOrder elementvoid removeInputOrder(IInputOrder element)
path
- The InputOrder elementIInputOrder[] getInputOrders()
IInputOrder getInputOrder(java.lang.String path)
path
- The path associated with the InputOrder element
IAdditionalInput createAdditionalInput(java.lang.String path)
path
- The path associated with the AdditionalInput element
void removeAdditionalInput(java.lang.String path)
path
- The path associated with the AdditionalInput elementvoid removeAdditionalInput(IAdditionalInput element)
element
- The AdditionalInput elementIAdditionalInput[] getAdditionalInputs()
IAdditionalInput getAdditionalInput(java.lang.String path)
path
- The path associated with the AdditionalInput element
org.eclipse.core.runtime.IPath[] getAdditionalResources()
org.eclipse.core.runtime.IPath[] getAdditionalDependencies()
ITool getParent()
IInputType getSuperClass()
IInputType
that is the superclass of this
InputType, or null
if the attribute was not specified.
org.eclipse.core.runtime.content.IContentType getSourceContentType()
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.
org.eclipse.core.runtime.content.IContentType[] getSourceContentTypes()
org.eclipse.core.runtime.content.IContentType[] getHeaderContentTypes()
java.lang.String[] getSourceContentTypeIds()
java.lang.String[] getHeaderContentTypeIds()
java.lang.String[] getHeaderExtensions(ITool tool)
java.lang.String[] getHeaderExtensionsAttribute()
void setSourceContentTypeIds(java.lang.String[] ids)
void setHeaderContentTypeIds(java.lang.String[] ids)
void setSourceExtensionsAttribute(java.lang.String[] extensions)
void setHeaderExtensionsAttribute(java.lang.String[] extensions)
void setSourceContentType(org.eclipse.core.runtime.content.IContentType contentType)
IContentType
that describes this
input type.
contentType
- The Eclipse content typejava.lang.String[] getSourceExtensionsAttribute()
void setSourceExtensionsAttribute(java.lang.String extensions)
extensions
- The comma-separated list of valid file extensions
- not including the separator period.java.lang.String[] getSourceExtensions(ITool tool)
tool
- the tool that contains the input-type
boolean isSourceExtension(ITool tool, java.lang.String ext)
true
if the input type considers the file extension to be
one associated with a source file.
tool
- the tool that contains the input-typeext
- file extension of the source
org.eclipse.core.runtime.content.IContentType getDependencyContentType()
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.
void setDependencyContentType(org.eclipse.core.runtime.content.IContentType type)
IContentType
that describes the
dependency files of this input type.
java.lang.String[] getDependencyExtensionsAttribute()
void setDependencyExtensionsAttribute(java.lang.String extensions)
extensions
- The comma-separated list of valid dependency extensions
- not including the separator period.java.lang.String[] getDependencyExtensions(ITool tool)
tool
- the tool that contains the input-type
boolean isDependencyExtension(ITool tool, java.lang.String ext)
true
if the input type considers the file extension to be
one associated with a dependency file.
tool
- the tool that contains the input-typeext
- file extension of the source
java.lang.String getOptionId()
void setOptionId(java.lang.String optionId)
optionId
- java.lang.String getAssignToOptionId()
void setAssignToOptionId(java.lang.String optionId)
optionId
- boolean getMultipleOfType()
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.
void setMultipleOfType(boolean multiple)
multiple
- boolean getPrimaryInput()
true
if this inputType is considered the primary input
of the tool, else false
.
void setPrimaryInput(boolean primary)
primary
- IManagedDependencyGeneratorType getDependencyGenerator()
null
in which case, the receiver
should assume that the input type does not require dependency information
when the project is built.
java.lang.String getBuildVariable()
void setBuildVariable(java.lang.String variableName)
boolean isDirty()
true
if this element has changes that need to
be saved in the project file, else false
.
boolean isExtensionElement()
true
if this InputType was loaded from a manifest file,
and false
if it was loaded from a project (.cdtbuild) file.
void setDirty(boolean isDirty)
isDirty
- java.lang.String getLanguageId(ITool tool)
java.lang.String getLanguageName(ITool tool)
java.lang.String getDiscoveryProfileId(ITool tool)
void setLanguageIdAttribute(java.lang.String id)
void setLanguageNameAttribute(java.lang.String name)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |