org.eclipse.cdt.managedbuilder.core
Interface IBuilder

All Superinterfaces:
IBuildObject, IMakeBuilderInfo, IMakeCommonBuildInfo
All Known Implementing Classes:
Builder

public interface IBuilder
extends IBuildObject, IMakeBuilderInfo

This class represents the utility that drives the build process (typically, but not necessarily, a variant of "make"). It defines the command needed to invoke the build utility in the command attribute. Any special flags that need to be passed to the builder are defined in the arguments attribute. The builder can specify the error parser(s) to be used to parse its output. The builder also specifies a Java class that generates the build file.

Since:
2.1

Field Summary
static java.lang.String ARGUMENTS
           
static java.lang.String ATTRIBUTE_APPEND_ENVIRONMENT
           
static java.lang.String ATTRIBUTE_AUTO_ENABLED
           
static java.lang.String ATTRIBUTE_BUILD_PATH
           
static java.lang.String ATTRIBUTE_CLEAN_ENABLED
           
static java.lang.String ATTRIBUTE_CUSTOM_PROPS
           
static java.lang.String ATTRIBUTE_CUSTOMIZED_ERROR_PARSERS
           
static java.lang.String ATTRIBUTE_ENVIRONMENT
           
static java.lang.String ATTRIBUTE_IGNORE_ERR_CMD
           
static java.lang.String ATTRIBUTE_INCREMENTAL_ENABLED
           
static java.lang.String ATTRIBUTE_KEEP_ENV
           
static java.lang.String ATTRIBUTE_MANAGED_BUILD_ON
           
static java.lang.String ATTRIBUTE_PARALLEL_BUILD_CMD
           
static java.lang.String ATTRIBUTE_PARALLEL_BUILD_ON
           
static java.lang.String ATTRIBUTE_PARALLELIZATION_NUMBER
           
static java.lang.String ATTRIBUTE_STOP_ON_ERR
           
static java.lang.String ATTRIBUTE_SUPORTS_MANAGED_BUILD
           
static java.lang.String ATTRIBUTE_TARGET_AUTO
           
static java.lang.String ATTRIBUTE_TARGET_CLEAN
           
static java.lang.String ATTRIBUTE_TARGET_INCREMENTAL
           
static java.lang.String BUILDER_ELEMENT_NAME
           
static java.lang.String BUILDFILEGEN_ID
           
static java.lang.String COMMAND
           
static java.lang.String CONVERT_TO_ID
           
static java.lang.String DEFAULT_TARGET_AUTO
           
static java.lang.String DEFAULT_TARGET_CLEAN
           
static java.lang.String DEFAULT_TARGET_INCREMENTAL
           
static java.lang.String IS_SYSTEM
           
static java.lang.String IS_VARIABLE_CASE_SENSITIVE
           
static java.lang.String OUTPUT_ENTRIES
           
static java.lang.String PARALLEL_PATTERN_NUM
           
static java.lang.String PARALLEL_PATTERN_NUM_END
           
static java.lang.String PARALLEL_PATTERN_NUM_START
           
static java.lang.String RESERVED_MACRO_NAME_SUPPLIER
           
static java.lang.String RESERVED_MACRO_NAMES
           
static java.lang.String VARIABLE_FORMAT
           
static java.lang.String VERSIONS_SUPPORTED
           
 
Fields inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject
ID, NAME
 
Fields inherited from interface org.eclipse.cdt.newmake.core.IMakeBuilderInfo
BUILD_TARGET_AUTO, BUILD_TARGET_CLEAN, BUILD_TARGET_FULL, BUILD_TARGET_INCREAMENTAL, BUILD_TARGET_INCREMENTAL
 
Fields inherited from interface org.eclipse.cdt.newmake.core.IMakeCommonBuildInfo
ARGS_PREFIX, BUILD_ARGUMENTS, BUILD_COMMAND, BUILD_LOCATION
 
Method Summary
 boolean canKeepEnvironmentVariablesInBuildfile()
           
 java.lang.String getArguments()
          Returns the command line arguments to pass to the build/make utility used to build a configuration.
 org.eclipse.cdt.core.settings.model.extension.CBuildData getBuildData()
           
 java.lang.String getBuilderVariablePattern()
          Returns String representing the build variable pattern to be used while makefile generation
 IManagedBuilderMakefileGenerator getBuildFileGenerator()
          Returns the BuildfileGenerator used to generate buildfiles for this builder
 org.eclipse.core.runtime.IConfigurationElement getBuildFileGeneratorElement()
          Deprecated. - use getBuildFileGenerator() instead
 java.lang.String getBuildPath()
           
 java.lang.String getCommand()
          Returns the name of the build/make utility for the configuration.
 java.lang.String getConvertToId()
          Returns the 'convertToId' of this builder
 java.lang.String getErrorParserIds()
          Returns the semicolon separated list of unique IDs of the error parsers associated with the builder.
 java.lang.String[] getErrorParserList()
          Returns the ordered list of unique IDs of the error parsers associated with the builder.
 IFileContextBuildMacroValues getFileContextBuildMacroValues()
          Returns the IFileContextBuildMacroValues interface reference that specifies the file-context macro-values provided by the tool-integrator
 IToolChain getParent()
          Returns the tool-chain that is the parent of this builder.
 java.lang.String[] getReservedMacroNames()
          Returns an array of Strings representing the patterns of the builder/buildfile-generator reserved variables
 IReservedMacroNameSupplier getReservedMacroNameSupplier()
          Returns the tool-integrator defined implementation of the IReservedMacroNameSupplier to be used for detecting the builder/buildfile-generator reserved variables
 IBuilder getSuperClass()
          Returns the IBuilder that is the superclass of this target platform, or null if the attribute was not specified.
 java.lang.String getUniqueRealName()
           
 java.lang.String getUnusedChildren()
          Returns a semi-colon delimited list of child Ids of the superclass' children that should not be automatically inherited by this element.
 java.lang.String getVersionsSupported()
          Returns the 'versionsSupported' of this builder
 boolean isAbstract()
          Returns whether this element is abstract.
 boolean isCustomBuilder()
           
 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 builder was loaded from a manifest file, and false if it was loaded from a project (.cdtbuild) file.
 boolean isInternalBuilder()
           
 boolean isSystemObject()
           
 boolean isVariableCaseSensitive()
          Returns whether the builder supports case sensitive variables or not
 boolean keepEnvironmentVariablesInBuildfile()
           
 boolean matches(IBuilder builder)
           
 void setArguments(java.lang.String makeArgs)
          Sets the arguments to be passed to the build utility used by the receiver to produce a build goal.
 void setBuildFileGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
          Deprecated.  
 void setBuildPath(java.lang.String path)
           
 void setCommand(java.lang.String command)
          Sets the build command for the receiver to the value in the argument.
 void setConvertToId(java.lang.String convertToId)
          Sets the 'convertToId' attribute of the builder.
 void setDirty(boolean isDirty)
          Sets the element's "dirty" (have I been modified?)
 void setErrorParserIds(java.lang.String ids)
          Sets the semicolon separated list of error parser ids
 void setIsAbstract(boolean b)
          Sets the isAbstract attribute of the builder.
 void setKeepEnvironmentVariablesInBuildfile(boolean keep)
           
 void setVersionsSupported(java.lang.String versionsSupported)
          Sets the 'versionsSupported' attribute of the builder.
 boolean supportsCustomizedBuild()
           
 
Methods inherited from interface org.eclipse.cdt.managedbuilder.core.IBuildObject
getBaseId, getId, getManagedBuildRevision, getName, getVersion, setVersion
 
Methods inherited from interface org.eclipse.cdt.newmake.core.IMakeBuilderInfo
getAutoBuildTarget, getCleanBuildTarget, getFullBuildTarget, getIncrementalBuildTarget, isAutoBuildEnable, isCleanBuildEnabled, isFullBuildEnabled, isIncrementalBuildEnabled, setAutoBuildEnable, setAutoBuildTarget, setCleanBuildEnable, setCleanBuildTarget, setFullBuildEnable, setFullBuildTarget, setIncrementalBuildEnable, setIncrementalBuildTarget
 
Methods inherited from interface org.eclipse.cdt.newmake.core.IMakeCommonBuildInfo
appendEnvironment, getBuildArguments, getBuildAttribute, getBuildCommand, getBuildLocation, getEnvironment, getErrorParsers, getExpandedEnvironment, getParallelizationNum, isDefaultBuildCmd, isManagedBuildOn, isParallelBuildOn, isStopOnError, setAppendEnvironment, setBuildArguments, setBuildAttribute, setBuildCommand, setBuildLocation, setEnvironment, setErrorParsers, setManagedBuildOn, setParallelBuildOn, setParallelizationNum, setStopOnError, setUseDefaultBuildCmd, supportsBuild, supportsParallelBuild, supportsStopOnError
 

Field Detail

ARGUMENTS

static final java.lang.String ARGUMENTS
See Also:
Constant Field Values

BUILDER_ELEMENT_NAME

static final java.lang.String BUILDER_ELEMENT_NAME
See Also:
Constant Field Values

BUILDFILEGEN_ID

static final java.lang.String BUILDFILEGEN_ID
See Also:
Constant Field Values

COMMAND

static final java.lang.String COMMAND
See Also:
Constant Field Values

VERSIONS_SUPPORTED

static final java.lang.String VERSIONS_SUPPORTED
See Also:
Constant Field Values

CONVERT_TO_ID

static final java.lang.String CONVERT_TO_ID
See Also:
Constant Field Values

VARIABLE_FORMAT

static final java.lang.String VARIABLE_FORMAT
See Also:
Constant Field Values

IS_VARIABLE_CASE_SENSITIVE

static final java.lang.String IS_VARIABLE_CASE_SENSITIVE
See Also:
Constant Field Values

RESERVED_MACRO_NAMES

static final java.lang.String RESERVED_MACRO_NAMES
See Also:
Constant Field Values

RESERVED_MACRO_NAME_SUPPLIER

static final java.lang.String RESERVED_MACRO_NAME_SUPPLIER
See Also:
Constant Field Values

IS_SYSTEM

static final java.lang.String IS_SYSTEM
See Also:
Constant Field Values

ATTRIBUTE_BUILD_PATH

static final java.lang.String ATTRIBUTE_BUILD_PATH
See Also:
Constant Field Values

ATTRIBUTE_TARGET_AUTO

static final java.lang.String ATTRIBUTE_TARGET_AUTO
See Also:
Constant Field Values

ATTRIBUTE_TARGET_INCREMENTAL

static final java.lang.String ATTRIBUTE_TARGET_INCREMENTAL
See Also:
Constant Field Values

ATTRIBUTE_TARGET_CLEAN

static final java.lang.String ATTRIBUTE_TARGET_CLEAN
See Also:
Constant Field Values

ATTRIBUTE_CLEAN_ENABLED

static final java.lang.String ATTRIBUTE_CLEAN_ENABLED
See Also:
Constant Field Values

ATTRIBUTE_INCREMENTAL_ENABLED

static final java.lang.String ATTRIBUTE_INCREMENTAL_ENABLED
See Also:
Constant Field Values

ATTRIBUTE_AUTO_ENABLED

static final java.lang.String ATTRIBUTE_AUTO_ENABLED
See Also:
Constant Field Values

ATTRIBUTE_ENVIRONMENT

static final java.lang.String ATTRIBUTE_ENVIRONMENT
See Also:
Constant Field Values

ATTRIBUTE_APPEND_ENVIRONMENT

static final java.lang.String ATTRIBUTE_APPEND_ENVIRONMENT
See Also:
Constant Field Values

ATTRIBUTE_MANAGED_BUILD_ON

static final java.lang.String ATTRIBUTE_MANAGED_BUILD_ON
See Also:
Constant Field Values

ATTRIBUTE_KEEP_ENV

static final java.lang.String ATTRIBUTE_KEEP_ENV
See Also:
Constant Field Values

ATTRIBUTE_SUPORTS_MANAGED_BUILD

static final java.lang.String ATTRIBUTE_SUPORTS_MANAGED_BUILD
See Also:
Constant Field Values

ATTRIBUTE_CUSTOMIZED_ERROR_PARSERS

static final java.lang.String ATTRIBUTE_CUSTOMIZED_ERROR_PARSERS
See Also:
Constant Field Values

ATTRIBUTE_CUSTOM_PROPS

static final java.lang.String ATTRIBUTE_CUSTOM_PROPS
See Also:
Constant Field Values

ATTRIBUTE_IGNORE_ERR_CMD

static final java.lang.String ATTRIBUTE_IGNORE_ERR_CMD
See Also:
Constant Field Values

ATTRIBUTE_STOP_ON_ERR

static final java.lang.String ATTRIBUTE_STOP_ON_ERR
See Also:
Constant Field Values

ATTRIBUTE_PARALLEL_BUILD_CMD

static final java.lang.String ATTRIBUTE_PARALLEL_BUILD_CMD
See Also:
Constant Field Values

ATTRIBUTE_PARALLELIZATION_NUMBER

static final java.lang.String ATTRIBUTE_PARALLELIZATION_NUMBER
See Also:
Constant Field Values

ATTRIBUTE_PARALLEL_BUILD_ON

static final java.lang.String ATTRIBUTE_PARALLEL_BUILD_ON
See Also:
Constant Field Values

PARALLEL_PATTERN_NUM

static final java.lang.String PARALLEL_PATTERN_NUM
See Also:
Constant Field Values

PARALLEL_PATTERN_NUM_START

static final java.lang.String PARALLEL_PATTERN_NUM_START
See Also:
Constant Field Values

PARALLEL_PATTERN_NUM_END

static final java.lang.String PARALLEL_PATTERN_NUM_END
See Also:
Constant Field Values

OUTPUT_ENTRIES

static final java.lang.String OUTPUT_ENTRIES
See Also:
Constant Field Values

DEFAULT_TARGET_INCREMENTAL

static final java.lang.String DEFAULT_TARGET_INCREMENTAL
See Also:
Constant Field Values

DEFAULT_TARGET_CLEAN

static final java.lang.String DEFAULT_TARGET_CLEAN
See Also:
Constant Field Values

DEFAULT_TARGET_AUTO

static final java.lang.String DEFAULT_TARGET_AUTO
See Also:
Constant Field Values
Method Detail

getArguments

java.lang.String getArguments()
Returns the command line arguments to pass to the build/make utility used to build a configuration.

Returns:
String

getBuildFileGeneratorElement

org.eclipse.core.runtime.IConfigurationElement getBuildFileGeneratorElement()
Deprecated. - use getBuildFileGenerator() instead

Returns the plugin.xml element of the buildFileGenerator extension or null if none.

Returns:
IConfigurationElement

getBuildFileGenerator

IManagedBuilderMakefileGenerator getBuildFileGenerator()
Returns the BuildfileGenerator used to generate buildfiles for this builder

Returns:
IManagedBuilderMakefileGenerator

getCommand

java.lang.String getCommand()
Returns the name of the build/make utility for the configuration.

Returns:
String

getErrorParserIds

java.lang.String getErrorParserIds()
Returns the semicolon separated list of unique IDs of the error parsers associated with the builder.

Returns:
String

getErrorParserList

java.lang.String[] getErrorParserList()
Returns the ordered list of unique IDs of the error parsers associated with the builder.

Returns:
String[]

getParent

IToolChain getParent()
Returns the tool-chain that is the parent of this builder.

Returns:
IToolChain

getSuperClass

IBuilder getSuperClass()
Returns the IBuilder that is the superclass of this target platform, or null if the attribute was not specified.

Returns:
IBuilder

getUnusedChildren

java.lang.String getUnusedChildren()
Returns a semi-colon delimited list of child Ids of the superclass' children that should not be automatically inherited by this element. Returns an empty string if the attribute was not specified.

Returns:
String

isAbstract

boolean isAbstract()
Returns whether this element is abstract. Returns false if the attribute was not specified.

Returns:
boolean

isDirty

boolean isDirty()
Returns true if this element has changes that need to be saved in the project file, else false.

Returns:
boolean

isExtensionElement

boolean isExtensionElement()
Returns true if this builder was loaded from a manifest file, and false if it was loaded from a project (.cdtbuild) file.

Returns:
boolean

setArguments

void setArguments(java.lang.String makeArgs)
Sets the arguments to be passed to the build utility used by the receiver to produce a build goal.

Parameters:
makeArgs -

setBuildFileGeneratorElement

void setBuildFileGeneratorElement(org.eclipse.core.runtime.IConfigurationElement element)
Deprecated. 

Sets the BuildFileGenerator plugin.xml element

Parameters:
element -

setCommand

void setCommand(java.lang.String command)
Sets the build command for the receiver to the value in the argument.

Parameters:
command -

setDirty

void setDirty(boolean isDirty)
Sets the element's "dirty" (have I been modified?) flag.

Parameters:
isDirty -

setErrorParserIds

void setErrorParserIds(java.lang.String ids)
Sets the semicolon separated list of error parser ids

Parameters:
ids -

setIsAbstract

void setIsAbstract(boolean b)
Sets the isAbstract attribute of the builder.

Parameters:
b -

getVersionsSupported

java.lang.String getVersionsSupported()
Returns the 'versionsSupported' of this builder

Returns:
String

getConvertToId

java.lang.String getConvertToId()
Returns the 'convertToId' of this builder

Returns:
String

setVersionsSupported

void setVersionsSupported(java.lang.String versionsSupported)
Sets the 'versionsSupported' attribute of the builder.

Parameters:
versionsSupported -

setConvertToId

void setConvertToId(java.lang.String convertToId)
Sets the 'convertToId' attribute of the builder.

Parameters:
convertToId -

getFileContextBuildMacroValues

IFileContextBuildMacroValues getFileContextBuildMacroValues()
Returns the IFileContextBuildMacroValues interface reference that specifies the file-context macro-values provided by the tool-integrator

Returns:
IFileContextBuildMacroValues

getBuilderVariablePattern

java.lang.String getBuilderVariablePattern()
Returns String representing the build variable pattern to be used while makefile generation

Returns:
String

isVariableCaseSensitive

boolean isVariableCaseSensitive()
Returns whether the builder supports case sensitive variables or not

Returns:
boolean

getReservedMacroNames

java.lang.String[] getReservedMacroNames()
Returns an array of Strings representing the patterns of the builder/buildfile-generator reserved variables

Returns:
String[]

getReservedMacroNameSupplier

IReservedMacroNameSupplier getReservedMacroNameSupplier()
Returns the tool-integrator defined implementation of the IReservedMacroNameSupplier to be used for detecting the builder/buildfile-generator reserved variables

Returns:
IReservedMacroNameSupplier

getBuildData

org.eclipse.cdt.core.settings.model.extension.CBuildData getBuildData()

isCustomBuilder

boolean isCustomBuilder()

supportsCustomizedBuild

boolean supportsCustomizedBuild()

keepEnvironmentVariablesInBuildfile

boolean keepEnvironmentVariablesInBuildfile()

setKeepEnvironmentVariablesInBuildfile

void setKeepEnvironmentVariablesInBuildfile(boolean keep)

canKeepEnvironmentVariablesInBuildfile

boolean canKeepEnvironmentVariablesInBuildfile()

setBuildPath

void setBuildPath(java.lang.String path)

getBuildPath

java.lang.String getBuildPath()

isInternalBuilder

boolean isInternalBuilder()

matches

boolean matches(IBuilder builder)

isSystemObject

boolean isSystemObject()

getUniqueRealName

java.lang.String getUniqueRealName()