org.eclipse.cdt.core.envvar
Interface IEnvironmentVariableManager
- All Known Implementing Classes:
- EnvironmentVariableManager
public interface IEnvironmentVariableManager
this interface represent the environment variable provider - the main entry-point
to be used for querying the build environment
- Since:
- 3.0
getVariable
IEnvironmentVariable getVariable(java.lang.String name,
org.eclipse.cdt.core.settings.model.ICConfigurationDescription cfg,
boolean resolveMacros)
- Parameters:
variableName
- environment variable name
if environment variable names are case insensitive in the current OS,
the environment variable provider will query the getVariable method of suppliers always
passing it the uppercase variable name not depending on the case of the variableName
passed to the IEnvironmentVariableProvider.getVariable() method. This will prevent the
supplier from answering different values for the same variable given the names that differ
only by case. E.g. if the current OS does not support case sensitive variables both of the
calls below:
provider.getVariable("FOO",level,includeParentContexts);
provider.getVariable("foo",level,includeParentContexts);
will result in asking suppliers for the "FOO" variablelevel
- could be one of the following:
1. IConfiguration to represent the configuration
2. IManagedProject to represent the managed project
3. IWorkspace to represent the workspace
4. null to represent the system environment passed to eclipse
- Returns:
- the reference to the IBuildEnvironmentVariable interface representing
the variable of a given name
getVariables
IEnvironmentVariable[] getVariables(org.eclipse.cdt.core.settings.model.ICConfigurationDescription cfg,
boolean resolveMacros)
- if environment variable names are case insensitive in the current OS,
the environment variable provider will remove the duplicates of the variables if their names
differ only by case
- Returns:
- the array of IBuildEnvironmentVariable that represents the environment variables
getDefaultDelimiter
java.lang.String getDefaultDelimiter()
- Returns:
- the String representing default system delimiter. That is the ":" for Unix-like
systems and the ";" for Win32 systems. This method will be used by the
tool-integrator provided variable supplier e.g. in order to concatenate the list of paths into the
environment variable, etc.
isVariableCaseSensitive
boolean isVariableCaseSensitive()
- Returns:
- true if the OS supports case sensitive variables (Unix-like systems) or false
if it does not (Win32 systems)
getContributedEnvironment
IContributedEnvironment getContributedEnvironment()