Package org.eclipse.cdt.core.build
Class ErrorBuildConfiguration
java.lang.Object
org.eclipse.core.runtime.PlatformObject
org.eclipse.cdt.core.build.ErrorBuildConfiguration
- All Implemented Interfaces:
ICBuildConfiguration,ICBuildConfiguration2,IScannerInfoProvider,org.eclipse.core.runtime.IAdaptable
public class ErrorBuildConfiguration
extends org.eclipse.core.runtime.PlatformObject
implements ICBuildConfiguration, ICBuildConfiguration2
A Build configuration that simply spits out an error message on the console at build and clean time.
Used to signify that we're not sure how to build this project in it's current state.
TODO leaving most of the implementation as default. I don't think any of these methods get called when
we're in this error state but we'll keep an eye open for NPE's and bad behavior.
- Since:
- 6.9
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final org.eclipse.cdt.core.build.ErrorBuildConfiguration.ProviderFields inherited from interface org.eclipse.cdt.core.build.ICBuildConfiguration
TOOLCHAIN_ID, TOOLCHAIN_TYPE -
Constructor Summary
ConstructorsConstructorDescriptionErrorBuildConfiguration(org.eclipse.core.resources.IBuildConfiguration config, String errorMessage) -
Method Summary
Modifier and TypeMethodDescriptionorg.eclipse.core.resources.IProject[]build(int kind, Map<String, String> args, IConsole console, org.eclipse.core.runtime.IProgressMonitor monitor) Perform the build.voidPerform clean.Ids for the Binary Parsers to use when checking whether a file is a binary that can be launched.org.eclipse.core.resources.IBuildConfigurationReturns the resources build configuration that this CDT build configuration is associated with.The URI for the directory in which the build is executed.getScannerInformation(org.eclipse.core.resources.IResource resource) The receiver will answer the current state of the build information for the resource specified in the argument.Build Configurations are configurations for a given toolchain.getVariable(String name) Return a build environment variable with a given name.Return all of the build environment variables for this configuration.voidMark the Build Configuration as activevoidsetErrorMessage(String errorMessage) voidsubscribe(org.eclipse.core.resources.IResource resource, IScannerInfoChangeListener listener) The receiver will register the listener specified in the argument to receive change notifications when the information for theIResourceit is responsible for changes.voidunsubscribe(org.eclipse.core.resources.IResource resource, IScannerInfoChangeListener listener) The receiver will no longer notify the listener specified in the argument when information about the reource it is responsible for changes.Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapterMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapterMethods inherited from interface org.eclipse.cdt.core.build.ICBuildConfiguration
getBuildOutput, getDefaultProperties, getLaunchMode, getLaunchTarget, getProperties, getProperty, removeProperty, setBuildEnvironment, setProperties, setProperty, supportsProperties
-
Field Details
-
NAME
- See Also:
-
PROVIDER
public static final org.eclipse.cdt.core.build.ErrorBuildConfiguration.Provider PROVIDER
-
-
Constructor Details
-
ErrorBuildConfiguration
public ErrorBuildConfiguration(org.eclipse.core.resources.IBuildConfiguration config, String errorMessage)
-
-
Method Details
-
setErrorMessage
-
build
public org.eclipse.core.resources.IProject[] build(int kind, Map<String, String> args, IConsole console, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreExceptionDescription copied from interface:ICBuildConfigurationPerform the build.- Specified by:
buildin interfaceICBuildConfiguration- Parameters:
kind- build typeargs- build argumentsconsole- console to show build outputmonitor- progress monitor- Returns:
- the list of projects for which this builder would like deltas the
next time it is run or
nullif none - Throws:
org.eclipse.core.runtime.CoreException
-
clean
public void clean(IConsole console, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException Description copied from interface:ICBuildConfigurationPerform clean.- Specified by:
cleanin interfaceICBuildConfiguration- Parameters:
console- console to show clean outputmonitor- progress monitor- Throws:
org.eclipse.core.runtime.CoreException
-
getScannerInformation
Description copied from interface:IScannerInfoProviderThe receiver will answer the current state of the build information for the resource specified in the argument.- Specified by:
getScannerInformationin interfaceIScannerInfoProvider
-
subscribe
public void subscribe(org.eclipse.core.resources.IResource resource, IScannerInfoChangeListener listener) Description copied from interface:IScannerInfoProviderThe receiver will register the listener specified in the argument to receive change notifications when the information for theIResourceit is responsible for changes.- Specified by:
subscribein interfaceIScannerInfoProvider- Parameters:
listener-
-
unsubscribe
public void unsubscribe(org.eclipse.core.resources.IResource resource, IScannerInfoChangeListener listener) Description copied from interface:IScannerInfoProviderThe receiver will no longer notify the listener specified in the argument when information about the reource it is responsible for changes.- Specified by:
unsubscribein interfaceIScannerInfoProvider- Parameters:
listener-
-
setActive
public void setActive()Description copied from interface:ICBuildConfiguration2Mark the Build Configuration as active- Specified by:
setActivein interfaceICBuildConfiguration2
-
getBuildDirectoryURI
Description copied from interface:ICBuildConfiguration2The URI for the directory in which the build is executed.- Specified by:
getBuildDirectoryURIin interfaceICBuildConfiguration2- Throws:
org.eclipse.core.runtime.CoreException
-
getBuildConfiguration
public org.eclipse.core.resources.IBuildConfiguration getBuildConfiguration() throws org.eclipse.core.runtime.CoreExceptionDescription copied from interface:ICBuildConfigurationReturns the resources build configuration that this CDT build configuration is associated with.- Specified by:
getBuildConfigurationin interfaceICBuildConfiguration- Returns:
- resources build configuration
- Throws:
org.eclipse.core.runtime.CoreException
-
getToolChain
Description copied from interface:ICBuildConfigurationBuild Configurations are configurations for a given toolchain.- Specified by:
getToolChainin interfaceICBuildConfiguration- Returns:
- the toolchain for this build configuration
- Throws:
org.eclipse.core.runtime.CoreException
-
getVariable
Description copied from interface:ICBuildConfigurationReturn a build environment variable with a given name.- Specified by:
getVariablein interfaceICBuildConfiguration- Parameters:
name- build environment variable name- Returns:
- value of the build environment variable.
- Throws:
org.eclipse.core.runtime.CoreException
-
getVariables
Description copied from interface:ICBuildConfigurationReturn all of the build environment variables for this configuration.- Specified by:
getVariablesin interfaceICBuildConfiguration- Returns:
- environment variables
- Throws:
org.eclipse.core.runtime.CoreException
-
getBinaryParserIds
Description copied from interface:ICBuildConfigurationIds for the Binary Parsers to use when checking whether a file is a binary that can be launched.- Specified by:
getBinaryParserIdsin interfaceICBuildConfiguration- Returns:
- binary parser ids
- Throws:
org.eclipse.core.runtime.CoreException
-