Package org.eclipse.cdt.core.envvar
Class EnvironmentVariable
java.lang.Object
org.eclipse.cdt.core.envvar.EnvironmentVariable
- All Implemented Interfaces:
Cloneable
,IEnvironmentVariable
- Direct Known Subclasses:
StorableEnvVar
A trivial implementation of
IEnvironmentVariable
- Since:
- 3.0
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected String
protected int
protected String
Fields inherited from interface org.eclipse.cdt.core.envvar.IEnvironmentVariable
ENVVAR_APPEND, ENVVAR_PREPEND, ENVVAR_REMOVE, ENVVAR_REPLACE
-
Constructor Summary
ModifierConstructorDescriptionprotected
EnvironmentVariable
(String name) EnvironmentVariable
(String name, String value) EnvironmentVariable
(String name, String value, int op, String delimiter) EnvironmentVariable
(String name, String value, String delimiter) -
Method Summary
-
Field Details
-
fName
-
fValue
-
fDelimiter
-
fOperation
protected int fOperation
-
-
Constructor Details
-
EnvironmentVariable
-
EnvironmentVariable
protected EnvironmentVariable() -
EnvironmentVariable
-
EnvironmentVariable
-
EnvironmentVariable
-
EnvironmentVariable
-
-
Method Details
-
getName
- Specified by:
getName
in interfaceIEnvironmentVariable
- Returns:
- the variable name
-
getValue
- Specified by:
getValue
in interfaceIEnvironmentVariable
- Returns:
- the variable value
-
getOperation
public int getOperation()- Specified by:
getOperation
in interfaceIEnvironmentVariable
- Returns:
- one of the IBuildEnvironmentVariable.ENVVAR_* operation types
-
getDelimiter
- Specified by:
getDelimiter
in interfaceIEnvironmentVariable
- Returns:
- if the variable can hold the list of values this method returns the String representing the delimiter that is used to separate values. This information is used for the following: 1. in append and prepend operations: If the variable already exists and contains some value the new value will be calculated in the following way: For the "prepend" operation: <New value> = <the value from the getValue() method><delimiter><Old value> For the "append" operation: <New value> = <Old value><delimiter><the value from the getValue() method> The Environment Variable Provider will also remove the duplicates of "sub-values" in the resulting value. For example: If the current value is "string1:string2:string3", the getDelimiter() method returns ":" and getValue() method returns "string4:string2" the new value will contain: For the "prepend" operation: "string4:string2:string1:string3" For the "append" operation: "string1:string3:string4:string2" 2. Since the environment variables are also treated as build macros the delimiter is also used by the BuildMacroProvider to determine the type of the macro used to represent the given environment variable. If the variable has the delimiter it is treated as the Text-List macro otherwise it is treated as the Text macro. (See Build Macro design for more details) To specify that no delimiter should be used, the getDelimiter() method should return null or an empty string
-
hashCode
public int hashCode() -
equals
-
toString
-
clone
-