|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.cdt.managedbuilder.internal.envvar.EnvironmentVariableProvider
public class EnvironmentVariableProvider
This class implements the IEnvironmentVariableProvider interface and provides all build environment funvtionality to the MBS
Nested Class Summary | |
---|---|
static class |
EnvironmentVariableProvider.DefaultBuildPathResolver
This class is used by the EnvironmentVariableProvider to calculate the build paths in case a tool-integrator did not provide the special logic for obtaining the build paths from environment variable values |
Method Summary | |
---|---|
void |
checkBuildPathVariables(IConfiguration configuration)
|
void |
checkBuildPathVariables(IConfiguration configuration,
int buildPathType)
|
java.lang.String[] |
getBuildPaths(IConfiguration configuration,
int buildPathType)
returns the array of String that holds the build paths of the specified type |
static EnvironmentVariableProvider |
getDefault()
|
java.lang.String |
getDefaultDelimiter()
|
IEnvironmentVariableSupplier[] |
getSuppliers(java.lang.Object level)
This method is defined to be used basically by the UI classes and should not be used by the tool-integrator |
IEnvironmentVariable |
getVariable(java.lang.String variableName,
IConfiguration cfg,
boolean resolveMacros)
|
IEnvironmentVariable |
getVariable(java.lang.String variableName,
IConfiguration cfg,
boolean resolveMacros,
boolean checkBuildPaths)
|
IBuildEnvironmentVariable |
getVariable(java.lang.String variableName,
java.lang.Object level,
boolean includeParentLevels,
boolean resolveMacros)
|
IEnvironmentVariable[] |
getVariables(IConfiguration cfg,
boolean resolveMacros)
|
IEnvironmentVariable[] |
getVariables(IConfiguration cfg,
boolean resolveMacros,
boolean checkBuildPaths)
|
IBuildEnvironmentVariable[] |
getVariables(java.lang.Object level,
boolean includeParentLevels,
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 |
boolean |
isVariableCaseSensitive()
|
void |
subscribe(IEnvironmentBuildPathsChangeListener listener)
adds the listener that will return notifications about the include and library paths changes. |
void |
unsubscribe(IEnvironmentBuildPathsChangeListener listener)
removes the include and library paths change listener |
static IBuildEnvironmentVariable |
wrap(IEnvironmentVariable var)
|
static IBuildEnvironmentVariable[] |
wrap(IEnvironmentVariable[] vars)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static EnvironmentVariableProvider getDefault()
public IBuildEnvironmentVariable getVariable(java.lang.String variableName, java.lang.Object level, boolean includeParentLevels, boolean resolveMacros)
getVariable
in interface IEnvironmentVariableProvider
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
public IEnvironmentVariable getVariable(java.lang.String variableName, IConfiguration cfg, boolean resolveMacros)
getVariable
in interface IEnvironmentVariableProvider
public IEnvironmentVariable getVariable(java.lang.String variableName, IConfiguration cfg, boolean resolveMacros, boolean checkBuildPaths)
public IEnvironmentVariable[] getVariables(IConfiguration cfg, boolean resolveMacros)
getVariables
in interface IEnvironmentVariableProvider
public IEnvironmentVariable[] getVariables(IConfiguration cfg, boolean resolveMacros, boolean checkBuildPaths)
public static IBuildEnvironmentVariable wrap(IEnvironmentVariable var)
public static IBuildEnvironmentVariable[] wrap(IEnvironmentVariable[] vars)
public IBuildEnvironmentVariable[] getVariables(java.lang.Object level, boolean includeParentLevels, boolean resolveMacros)
IEnvironmentVariableProvider
getVariables
in interface IEnvironmentVariableProvider
public java.lang.String getDefaultDelimiter()
getDefaultDelimiter
in interface IEnvironmentVariableProvider
public boolean isVariableCaseSensitive()
isVariableCaseSensitive
in interface IEnvironmentVariableProvider
public IEnvironmentVariableSupplier[] getSuppliers(java.lang.Object level)
IEnvironmentVariableProvider
getSuppliers
in interface IEnvironmentVariableProvider
public java.lang.String[] getBuildPaths(IConfiguration configuration, int buildPathType)
IEnvironmentVariableProvider
getBuildPaths
in interface IEnvironmentVariableProvider
configuration
- represent the configuration for which the paths were changedbuildPathType
- can be set to one of the IEnvVarBuildPath.BUILDPATH _xxx
(the IEnvVarBuildPath will represent the build environment variables, see also
the "Specifying the Includes and Library paths environment variables",
the "envVarBuildPath schema" and the "Expected CDT/MBS code changes" sections)public void subscribe(IEnvironmentBuildPathsChangeListener listener)
IEnvironmentVariableProvider
subscribe
in interface IEnvironmentVariableProvider
public void unsubscribe(IEnvironmentBuildPathsChangeListener listener)
IEnvironmentVariableProvider
unsubscribe
in interface IEnvironmentVariableProvider
public void checkBuildPathVariables(IConfiguration configuration)
public void checkBuildPathVariables(IConfiguration configuration, int buildPathType)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |