|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IOutputType
This interface represents an outputType instance in the managed build system. It describes one category of output files created by a Tool. A tool can have multiple outputType children.
Field Summary | |
---|---|
static java.lang.String |
BUILD_VARIABLE
|
static java.lang.String |
MULTIPLE_OF_TYPE
|
static java.lang.String |
NAME_PATTERN
|
static java.lang.String |
NAME_PROVIDER
|
static java.lang.String |
OPTION
|
static java.lang.String |
OUTPUT_CONTENT_TYPE
|
static java.lang.String |
OUTPUT_NAMES
|
static java.lang.String |
OUTPUT_PREFIX
|
static java.lang.String |
OUTPUT_TYPE_ELEMENT_NAME
|
static java.lang.String |
OUTPUTS
|
static java.lang.String |
PRIMARY_INPUT_TYPE
|
static java.lang.String |
PRIMARY_OUTPUT
|
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
ID, NAME |
Method Summary | |
---|---|
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. |
boolean |
getMultipleOfType()
Returns true if this outputType creates multiple output
resources in one invocation of the tool, else false . |
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. |
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[] |
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. |
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 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. |
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 multiple)
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 |
setOptionId(java.lang.String optionId)
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 contentType)
Sets the Eclipse IContentType that describes this
output type. |
void |
setOutputExtensionsAttribute(java.lang.String extensions)
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 contentType)
Sets the input type that is used in determining the default names of this output type. |
void |
setPrimaryOutput(boolean primary)
Sets whether this is the primary output of the tool. |
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject |
---|
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion |
Field Detail |
---|
static final java.lang.String OUTPUT_TYPE_ELEMENT_NAME
static final java.lang.String OUTPUT_CONTENT_TYPE
static final java.lang.String OUTPUTS
static final java.lang.String OPTION
static final java.lang.String MULTIPLE_OF_TYPE
static final java.lang.String PRIMARY_INPUT_TYPE
static final java.lang.String PRIMARY_OUTPUT
static final java.lang.String OUTPUT_PREFIX
static final java.lang.String OUTPUT_NAMES
static final java.lang.String NAME_PATTERN
static final java.lang.String NAME_PROVIDER
static final java.lang.String BUILD_VARIABLE
Method Detail |
---|
ITool getParent()
IOutputType getSuperClass()
IOutputType
that is the superclass of this
OutputType, or null
if the attribute was not specified.
org.eclipse.core.runtime.content.IContentType getOutputContentType()
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.
void setOutputContentType(org.eclipse.core.runtime.content.IContentType contentType)
IContentType
that describes this
output type.
contentType
- The Eclipse content typejava.lang.String[] getOutputExtensionsAttribute()
String[]
of extensionsvoid setOutputExtensionsAttribute(java.lang.String extensions)
String
- java.lang.String[] getOutputExtensions(ITool tool)
tool
- the tool that contains the output-type
boolean isOutputExtension(ITool tool, java.lang.String ext)
true
if the output type considers the file extension to be
one associated with an output file.
tool
- the tool that contains the output-typeext
- file extension
java.lang.String getOptionId()
void setOptionId(java.lang.String optionId)
optionId
- boolean getMultipleOfType()
true
if this outputType creates multiple output
resources in one invocation of the tool, else false
.
void setMultipleOfType(boolean multiple)
multiple
- IInputType getPrimaryInputType()
void setPrimaryInputType(IInputType contentType)
inputType
- boolean getPrimaryOutput()
true
if this is considered the primary output
of the tool, else false
.
void setPrimaryOutput(boolean primary)
primary
- java.lang.String getOutputPrefix()
void setOutputPrefix(java.lang.String prefix)
String
- java.lang.String[] getOutputNames()
void setOutputNames(java.lang.String names)
names
- java.lang.String getNamePattern()
void setNamePattern(java.lang.String pattern)
IManagedOutputNameProvider getNameProvider()
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 OutputType was loaded from a manifest file,
and false
if it was loaded from a project (.cdtbuild) file.
void setDirty(boolean isDirty)
isDirty
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |