org.eclipse.cdt.managedbuilder.envvar
Interface IProjectEnvironmentVariableSupplier


public interface IProjectEnvironmentVariableSupplier

this interface is to be implemented by the tool-integrator for supplying the project-specific environment

Since:
3.0

Method Summary
 IBuildEnvironmentVariable getVariable(java.lang.String variableName, IManagedProject project, IEnvironmentVariableProvider provider)
           
 IBuildEnvironmentVariable[] getVariables(IManagedProject project, IEnvironmentVariableProvider provider)
           
 

Method Detail

getVariable

IBuildEnvironmentVariable getVariable(java.lang.String variableName,
                                      IManagedProject project,
                                      IEnvironmentVariableProvider provider)
Parameters:
variableName - the variable name
project - the managed project
provider - the instance of the environment variable provider to be used for querying the environment variables from within the supplier. The supplier should use this provider to obtain the already defined environment instead of using the "default" provider returned by the ManagedBuildManager.getEnvironmentVariableProvider(). The provider passed to a supplier will ignore searching the variables for the levels higher than the current supplier level, will query only the lower-precedence suppliers for the current level and will query all suppliers for the lower levels. This is done to avoid infinite loops that could be caused if the supplier calls the provider and the provider in turn calls that supplier again. Also the supplier should not know anything about the environment variables defined for the higher levels.
Returns:
the reference to the IBuildEnvironmentVariable interface representing the variable of a given name

getVariables

IBuildEnvironmentVariable[] getVariables(IManagedProject project,
                                         IEnvironmentVariableProvider provider)
Parameters:
project - the managed project
provider - the instance of the environment variable provider to be used for querying the environment variables from within the supplier. The supplier should use this provider to obtain the already defined environment instead of using the "default" provider returned by the ManagedBuildManager.getEnvironmentVariableProvider(). The provider passed to a supplier will ignore searching the variables for the levels higher than the current supplier level, will query only the lower-precedence suppliers for the current level and will query all suppliers for the lower levels. This is done to avoid infinite loops that could be caused if the supplier calls the provider and the provider in turn calls that supplier again. Also the supplier should not know anything about the environment variables defined for the higher levels.
Returns:
the array of IBuildEnvironmentVariable that represents the environment variables