|
||||||||||
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.OutputType
public class OutputType
Field Summary |
---|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IOutputType |
---|
BUILD_VARIABLE, MULTIPLE_OF_TYPE, NAME_PATTERN, NAME_PROVIDER, OPTION, OUTPUT_CONTENT_TYPE, OUTPUT_NAMES, OUTPUT_PREFIX, OUTPUT_TYPE_ELEMENT_NAME, OUTPUTS, PRIMARY_INPUT_TYPE, PRIMARY_OUTPUT |
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Constructor Summary | |
---|---|
OutputType(ITool parent,
org.eclipse.cdt.core.settings.model.ICStorageElement element)
Create an OutputType based on the specification stored in the
project file (.cdtbuild). |
|
OutputType(ITool parent,
IManagedConfigElement element)
This constructor is called to create an OutputType defined by an extension point in a plugin manifest file, or returned by a dynamic element provider |
|
OutputType(ITool parent,
java.lang.String Id,
java.lang.String name,
OutputType outputType)
Create an OutputType based upon an existing OutputType. |
|
OutputType(Tool parent,
IOutputType superClass,
java.lang.String Id,
java.lang.String name,
boolean isExtensionElement)
This constructor is called to create an OutputType whose attributes will be set by separate calls. |
Method Summary | |
---|---|
BooleanExpressionApplicabilityCalculator |
getBooleanExpressionCalculator()
|
java.lang.String |
getBuildVariable()
Returns the name of the build variable associated this this output type's resources The variable is used in the build file to represent the list of output files. |
java.lang.String |
getManagedBuildRevision()
|
boolean |
getMultipleOfType()
Returns true if this outputType creates multiple output
resources in one invocation of the tool, else false . |
java.lang.String |
getName()
|
java.lang.String |
getNamePattern()
Returns the pattern, using the Gnu pattern rule syntax, for deriving the output resource name from the input resource name. |
IManagedOutputNameProvider |
getNameProvider()
Returns the IManagedOutputNameProvider interface as specified by the nameProvider attribute. |
org.eclipse.core.runtime.IConfigurationElement |
getNameProviderElement()
|
java.lang.String |
getOptionId()
Returns the id of the option that is associated with this output type on the command line. |
org.eclipse.core.runtime.content.IContentType |
getOutputContentType()
Returns the Eclipse IContentType that describes this
output type. |
java.lang.String[] |
getOutputExtensions(ITool tool)
Returns the list of the output extensions that the receiver can build. |
java.lang.String[] |
getOutputExtensions(ITool tool,
org.eclipse.core.resources.IProject project)
|
java.lang.String[] |
getOutputExtensionsAttribute()
Returns the list of valid output extensions from the outputs attribute. |
java.lang.String[] |
getOutputNames()
Returns the file names of the complete set of output files for this outputType |
java.lang.String |
getOutputPrefix()
Returns the prefix that the tool should prepend to the name of the build artifact. |
ITool |
getParent()
Returns the tool defining this OutputType. |
IInputType |
getPrimaryInputType()
Returns the input type that is used in determining the default names of this output type. |
boolean |
getPrimaryOutput()
Returns true if this is considered the primary output
of the tool, else false . |
IOutputType |
getSuperClass()
Returns the IOutputType that is the superclass of this
OutputType, or null if the attribute was not specified. |
org.eclipse.core.runtime.PluginVersionIdentifier |
getVersion()
|
boolean |
hasCustomSettings()
|
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 OutputType was loaded from a manifest file,
and false if it was loaded from a project (.cdtbuild) file. |
boolean |
isOutputExtension(ITool tool,
java.lang.String ext)
Answers true if the output type considers the file extension to be
one associated with an output file. |
boolean |
needsRebuild()
|
void |
resolveReferences()
|
void |
serialize(org.eclipse.cdt.core.settings.model.ICStorageElement element)
Persist the OutputType to the project file. |
void |
setBuildVariable(java.lang.String variableName)
Sets the name of the build variable associated this this output type's resources. |
void |
setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) |
void |
setMultipleOfType(boolean b)
Sets whether this outputType can create multiple output resources in one invocation of the tool. |
void |
setNamePattern(java.lang.String pattern)
Sets the pattern, using the Gnu pattern rule syntax, for deriving the output resource name from the input resource name. |
void |
setNameProviderElement(org.eclipse.core.runtime.IConfigurationElement element)
|
void |
setOptionId(java.lang.String id)
Sets the id of the option that is associated with this output type on the command line. |
void |
setOutputContentType(org.eclipse.core.runtime.content.IContentType type)
Sets the Eclipse IContentType that describes this
output type. |
void |
setOutputExtensionsAttribute(java.lang.String exts)
Sets all of the output extensions that the receiver can build. |
void |
setOutputNames(java.lang.String names)
Sets the complete set of output file names for this outputType |
void |
setOutputPrefix(java.lang.String prefix)
Sets the prefix that the tool should prepend to the name of the build artifact. |
void |
setPrimaryInputType(IInputType type)
Sets the input type that is used in determining the default names of this output type. |
void |
setPrimaryOutput(boolean b)
Sets whether this is the primary output of the tool. |
void |
setRebuildState(boolean rebuild)
|
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 OutputType(ITool parent, IManagedConfigElement element)
parent
- The ITool parent of this OutputTypeelement
- The OutputType definition from the manifest file or a dynamic element
providerpublic OutputType(Tool parent, IOutputType superClass, java.lang.String Id, java.lang.String name, boolean isExtensionElement)
Tool
- The parent of the an OutputTypeOutputType
- The superClass, if anyString
- The id for the new OutputTypeString
- The name for the new OutputTypeboolean
- Indicates whether this is an extension element or a managed project elementpublic OutputType(ITool parent, org.eclipse.cdt.core.settings.model.ICStorageElement element)
OutputType
based on the specification stored in the
project file (.cdtbuild).
parent
- The ITool
the OutputType will be added to.element
- The XML element that contains the OutputType settings.public OutputType(ITool parent, java.lang.String Id, java.lang.String name, OutputType outputType)
OutputType
based upon an existing OutputType.
parent
- The ITool
the OutputType will be added to.Id
- The identifier of the new OutputTypename
- The name of the new OutputTypeoutputType
- The existing OutputType to clone.Method Detail |
---|
public void serialize(org.eclipse.cdt.core.settings.model.ICStorageElement element)
doc
- element
- public ITool getParent()
IOutputType
getParent
in interface IOutputType
public IOutputType getSuperClass()
IOutputType
IOutputType
that is the superclass of this
OutputType, or null
if the attribute was not specified.
getSuperClass
in interface IOutputType
public java.lang.String getName()
getName
in interface IBuildObject
getName
in class BuildObject
public java.lang.String getBuildVariable()
IOutputType
getBuildVariable
in interface IOutputType
public void setBuildVariable(java.lang.String variableName)
IOutputType
setBuildVariable
in interface IOutputType
public boolean getMultipleOfType()
IOutputType
true
if this outputType creates multiple output
resources in one invocation of the tool, else false
.
getMultipleOfType
in interface IOutputType
public void setMultipleOfType(boolean b)
IOutputType
setMultipleOfType
in interface IOutputType
public java.lang.String getNamePattern()
IOutputType
getNamePattern
in interface IOutputType
public void setNamePattern(java.lang.String pattern)
IOutputType
setNamePattern
in interface IOutputType
public org.eclipse.core.runtime.IConfigurationElement getNameProviderElement()
public void setNameProviderElement(org.eclipse.core.runtime.IConfigurationElement element)
public IManagedOutputNameProvider getNameProvider()
IOutputType
getNameProvider
in interface IOutputType
public java.lang.String getOptionId()
IOutputType
getOptionId
in interface IOutputType
public void setOptionId(java.lang.String id)
IOutputType
setOptionId
in interface IOutputType
public org.eclipse.core.runtime.content.IContentType getOutputContentType()
IOutputType
IContentType
that describes this
output type. If both the outputs attribute and the outputContentType
attribute are specified, the outputContentType will be used if it
is defined in Eclipse.
getOutputContentType
in interface IOutputType
public void setOutputContentType(org.eclipse.core.runtime.content.IContentType type)
IOutputType
IContentType
that describes this
output type.
setOutputContentType
in interface IOutputType
type
- The Eclipse content typepublic java.lang.String[] getOutputExtensionsAttribute()
IOutputType
getOutputExtensionsAttribute
in interface IOutputType
String[]
of extensionspublic void setOutputExtensionsAttribute(java.lang.String exts)
IOutputType
setOutputExtensionsAttribute
in interface IOutputType
public java.lang.String[] getOutputExtensions(ITool tool, org.eclipse.core.resources.IProject project)
public java.lang.String[] getOutputExtensions(ITool tool)
IOutputType
getOutputExtensions
in interface IOutputType
tool
- the tool that contains the output-type
public boolean isOutputExtension(ITool tool, java.lang.String ext)
IOutputType
true
if the output type considers the file extension to be
one associated with an output file.
isOutputExtension
in interface IOutputType
tool
- the tool that contains the output-typeext
- file extension
public java.lang.String getOutputPrefix()
IOutputType
getOutputPrefix
in interface IOutputType
public void setOutputPrefix(java.lang.String prefix)
IOutputType
setOutputPrefix
in interface IOutputType
public java.lang.String[] getOutputNames()
IOutputType
getOutputNames
in interface IOutputType
public void setOutputNames(java.lang.String names)
IOutputType
setOutputNames
in interface IOutputType
public IInputType getPrimaryInputType()
IOutputType
getPrimaryInputType
in interface IOutputType
public void setPrimaryInputType(IInputType type)
IOutputType
setPrimaryInputType
in interface IOutputType
public boolean getPrimaryOutput()
IOutputType
true
if this is considered the primary output
of the tool, else false
.
getPrimaryOutput
in interface IOutputType
public void setPrimaryOutput(boolean b)
IOutputType
setPrimaryOutput
in interface IOutputType
public boolean isExtensionElement()
IOutputType
true
if this OutputType was loaded from a manifest file,
and false
if it was loaded from a project (.cdtbuild) file.
isExtensionElement
in interface IOutputType
public boolean isDirty()
IOutputType
true
if this element has changes that need to
be saved in the project file, else false
.
isDirty
in interface IOutputType
public void setDirty(boolean isDirty)
IOutputType
setDirty
in interface IOutputType
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 BooleanExpressionApplicabilityCalculator getBooleanExpressionCalculator()
public boolean isEnabled(ITool tool)
public boolean hasCustomSettings()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |