org.eclipse.cdt.internal.core.envvar
Class UserDefinedEnvironmentSupplier

java.lang.Object
  extended by org.eclipse.cdt.utils.envvar.StorableEnvironmentLoader
      extended by org.eclipse.cdt.internal.core.envvar.UserDefinedEnvironmentSupplier
All Implemented Interfaces:
ICoreEnvironmentVariableSupplier

public class UserDefinedEnvironmentSupplier
extends org.eclipse.cdt.utils.envvar.StorableEnvironmentLoader
implements ICoreEnvironmentVariableSupplier

This is the Environment Variable Supplier used to supply variables defined by a user

Since:
3.0

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.cdt.utils.envvar.StorableEnvironmentLoader
org.eclipse.cdt.utils.envvar.StorableEnvironmentLoader.ISerializeInfo
 
Field Summary
static java.lang.String NODENAME
           
static java.lang.String NODENAME_CFG
           
static java.lang.String PREFNAME_PROJECT
           
static java.lang.String PREFNAME_WORKSPACE
           
 
Constructor Summary
UserDefinedEnvironmentSupplier()
           
 
Method Summary
 boolean appendContributedEnvironment(java.lang.Object context)
           
 boolean appendEnvironment(java.lang.Object context)
           
 void checkInexistentConfigurations(org.eclipse.cdt.core.settings.model.ICProjectDescription projDes)
           
 IEnvironmentVariable createVariable(java.lang.String name, java.lang.String value, int op, java.lang.String delimiter, java.lang.Object context)
           
 void deleteAll(java.lang.Object context)
           
 IEnvironmentVariable deleteVariable(java.lang.String name, java.lang.Object context)
           
 IEnvironmentVariable getVariable(java.lang.String name, java.lang.Object context)
           
 IEnvironmentVariable[] getVariables(java.lang.Object context)
           
 org.eclipse.cdt.utils.envvar.StorableEnvironment getWorkspaceEnvironmentCopy()
           
 void restoreDefaults(java.lang.Object context)
           
 void setAppendContributedEnvironment(boolean append, java.lang.Object context)
           
 void setAppendEnvironment(boolean append, java.lang.Object context)
           
 void setVariables(IEnvironmentVariable[] vars, java.lang.Object context)
           
 boolean setWorkspaceEnvironment(org.eclipse.cdt.utils.envvar.StorableEnvironment env)
           
 void storeProjectEnvironment(org.eclipse.cdt.core.settings.model.ICProjectDescription des, boolean force)
           
 void storeWorkspaceEnvironment(boolean force)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NODENAME

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

PREFNAME_WORKSPACE

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

PREFNAME_PROJECT

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

NODENAME_CFG

public static final java.lang.String NODENAME_CFG
See Also:
Constant Field Values
Constructor Detail

UserDefinedEnvironmentSupplier

public UserDefinedEnvironmentSupplier()
Method Detail

checkInexistentConfigurations

public void checkInexistentConfigurations(org.eclipse.cdt.core.settings.model.ICProjectDescription projDes)

storeWorkspaceEnvironment

public void storeWorkspaceEnvironment(boolean force)

getWorkspaceEnvironmentCopy

public org.eclipse.cdt.utils.envvar.StorableEnvironment getWorkspaceEnvironmentCopy()

setWorkspaceEnvironment

public boolean setWorkspaceEnvironment(org.eclipse.cdt.utils.envvar.StorableEnvironment env)

storeProjectEnvironment

public void storeProjectEnvironment(org.eclipse.cdt.core.settings.model.ICProjectDescription des,
                                    boolean force)

getVariable

public IEnvironmentVariable getVariable(java.lang.String name,
                                        java.lang.Object context)
Specified by:
getVariable in interface ICoreEnvironmentVariableSupplier
Parameters:
name - the variable name
context - the context
Returns:
the reference to the IBuildEnvironmentVariable interface representing the variable of a given name

getVariables

public IEnvironmentVariable[] getVariables(java.lang.Object context)
Specified by:
getVariables in interface ICoreEnvironmentVariableSupplier
Parameters:
context - the context
Returns:
the array of IBuildEnvironmentVariable that represents the environment variables

createVariable

public IEnvironmentVariable createVariable(java.lang.String name,
                                           java.lang.String value,
                                           int op,
                                           java.lang.String delimiter,
                                           java.lang.Object context)

deleteVariable

public IEnvironmentVariable deleteVariable(java.lang.String name,
                                           java.lang.Object context)

deleteAll

public void deleteAll(java.lang.Object context)

setVariables

public void setVariables(IEnvironmentVariable[] vars,
                         java.lang.Object context)

appendEnvironment

public boolean appendEnvironment(java.lang.Object context)
Specified by:
appendEnvironment in interface ICoreEnvironmentVariableSupplier

appendContributedEnvironment

public boolean appendContributedEnvironment(java.lang.Object context)

setAppendEnvironment

public void setAppendEnvironment(boolean append,
                                 java.lang.Object context)

setAppendContributedEnvironment

public void setAppendContributedEnvironment(boolean append,
                                            java.lang.Object context)

restoreDefaults

public void restoreDefaults(java.lang.Object context)