org.eclipse.cdt.managedbuilder.core
Interface IToolReference

All Superinterfaces:
IBuildObject, IHoldsOptions, ITool
All Known Implementing Classes:
ToolReference

public interface IToolReference
extends ITool


Field Summary
 
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.ITool
ADVANCED_INPUT_CATEGORY, ANNOUNCEMENT, COMMAND, COMMAND_LINE_GENERATOR, COMMAND_LINE_PATTERN, CONVERT_TO_ID, CUSTOM_BUILD_STEP, DEP_CALC_ID, EMPTY_STRING, FILTER_BOTH, FILTER_C, FILTER_CC, INPUT_TYPE, INTERFACE_EXTS, IS_SYSTEM, NATURE, OPTIONPATHCONVERTER, OUTPUT_FLAG, OUTPUT_PREFIX, OUTPUT_TYPE, OUTPUTS, SOURCES, SUPPORTS_MANAGED_BUILD, TOOL_ELEMENT_NAME, VERSIONS_SUPPORTED, WHITE_SPACE
 
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IHoldsOptions
OPTION, OPTION_CAT, OPTION_REF
 
Method Summary
 OptionReference createOptionReference(IOption option)
          Answers a reference to the option.
 java.util.List getOptionReferenceList()
          Answers the list of option references contained in the receiver.
 java.lang.String getRawOutputExtensions()
          Answers all of the output extensions that the receiver can build.
 java.lang.String getRawOutputFlag()
          Answers the argument that must be passed to a specific tool in order to control the name of the output artifact.
 java.lang.String getRawOutputPrefix()
          Answers the prefix that the tool should prepend to the name of the build artifact.
 java.lang.String getRawToolCommand()
          Answers the command-line invocation defined for the receiver.
 ITool getTool()
          Answers the tool that the reference has been created for.
 boolean isDirty()
          Answers true if the receiver ahs been modified in any way.
 boolean references(ITool tool)
          Answers true if the reference is a reference to the tool specified in the argument.
 void setDirty(boolean isDirty)
          Sets the element's "dirty" (have I been modified?)
 boolean setToolCommand(java.lang.String cmd)
          Set the tool command in the receiver to be the argument.
 
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.ITool
buildsFileType, createInputType, createOutputType, getAdditionalDependencies, getAdditionalResources, getAdvancedInputCategory, getAllDependencyExtensions, getAllInputExtensions, getAllOutputExtensions, getAnnouncement, getCLanguageData, getCLanguageDatas, getCommandFlags, getCommandLineGenerator, getCommandLineGeneratorElement, getCommandLinePattern, getConvertToId, getCustomBuildStep, getDefaultInputExtension, getDependencyGenerator, getDependencyGeneratorElement, getDependencyGeneratorForExtension, getEdtableInputType, getEdtableOutputType, getEnvVarBuildPaths, getErrorParserIds, getErrorParserList, getInputExtensions, getInputType, getInputTypeById, getInputTypeForCLanguageData, getInputTypes, getInterfaceExtensions, getNatureFilter, getOptionPathConverter, getOutputExtension, getOutputExtensions, getOutputFlag, getOutputPrefix, getOutputsAttribute, getOutputType, getOutputTypeById, getOutputTypes, getParent, getParentResourceInfo, getPrimaryInputExtensions, getPrimaryInputType, getPrimaryOutputType, getSuperClass, getToolCommand, getToolCommandFlags, getToolCommandFlagsString, getToolFlags, getTopOptionCategory, getUniqueRealName, getUnusedChildren, getVersionsSupported, isAbstract, isEnabled, isExtensionElement, isHeaderFile, isInputFileType, isSystemObject, matches, producesFileType, removeInputType, removeOutputType, setAdvancedInputCategory, setAnnouncement, setCommandLineGeneratorElement, setCommandLinePattern, setConvertToId, setCustomBuildStep, setDependencyGeneratorElement, setErrorParserIds, setIsAbstract, setOutputFlag, setOutputPrefix, setOutputPrefixForPrimaryOutput, setOutputsAttribute, setVersionsSupported, supportsBuild
 
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IHoldsOptions
addOptionCategory, createOption, createOptions, getChildCategories, getOption, getOptionById, getOptionBySuperClassId, getOptionCategory, getOptions, getOptionToSet, needsRebuild, removeOption, setRebuildState
 

Method Detail

createOptionReference

OptionReference createOptionReference(IOption option)
Answers a reference to the option. If the reference does not exist, a new reference is created.

Parameters:
option -
Returns:
OptionReference

getOptionReferenceList

java.util.List getOptionReferenceList()
Answers the list of option references contained in the receiver.

Returns:
List

getTool

ITool getTool()
Answers the tool that the reference has been created for.

Returns:

isDirty

boolean isDirty()
Answers true if the receiver ahs been modified in any way.

Specified by:
isDirty in interface ITool
Returns:
boolean

references

boolean references(ITool tool)
Answers true if the reference is a reference to the tool specified in the argument.

Parameters:
target - the tool that should be tested
Returns:
boolean

setDirty

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

Specified by:
setDirty in interface ITool
Parameters:
isDirty - The value to set the dirty flag to in the receiver

setToolCommand

boolean setToolCommand(java.lang.String cmd)
Set the tool command in the receiver to be the argument.

Specified by:
setToolCommand in interface ITool
Parameters:
cmd -
Returns:
true if the command is changed, else false

getRawOutputExtensions

java.lang.String getRawOutputExtensions()
Answers all of the output extensions that the receiver can build.

Returns:
String

getRawOutputFlag

java.lang.String getRawOutputFlag()
Answers the argument that must be passed to a specific tool in order to control the name of the output artifact. For example, the GCC compile and linker use '-o', while the archiver does not.

Returns:
String

getRawOutputPrefix

java.lang.String getRawOutputPrefix()
Answers the prefix that the tool should prepend to the name of the build artifact. For example, a librarian usually prepends 'lib' to the target.a

Returns:
String

getRawToolCommand

java.lang.String getRawToolCommand()
Answers the command-line invocation defined for the receiver.

Returns:
String