public interface ICdtVariableManager
Modifier and Type | Method and Description |
---|---|
void |
checkVariableIntegrity(ICConfigurationDescription cfg)
checks the integrity of the Macros
If there are inconsistencies, such as when a macro value refers to a nonexistent macro
or when two macros refer to each other, this method will throw the BuildMacroException exception
The BuildMacroException will contain the human-readable string describing
the inconsistency and the array of the IBuildMacro interfaces that will represent the macros that
caused the inconsistency.
|
String |
convertStringListToString(String[] value,
String listDelimiter)
converts StringList value into String of the following format:
"
|
ICdtVariable |
getVariable(String name,
ICConfigurationDescription cfg)
Returns reference to the IBuildMacro interface representing Macro of the
specified name or null if there is there is no such macro
|
ICdtVariable[] |
getVariables(ICConfigurationDescription cfg) |
boolean |
isEnvironmentVariable(ICdtVariable variable,
ICConfigurationDescription cfg) |
boolean |
isStringListValue(String value,
ICConfigurationDescription cfg) |
boolean |
isUserVariable(ICdtVariable variable,
ICConfigurationDescription cfg) |
String[] |
resolveStringListValue(String value,
String nonexistentMacrosValue,
String listDelimiter,
ICConfigurationDescription cfg)
if the string contains a value that can be treated as a StringList resolves it to arrays of strings
otherwise throws the BuildMacroException exception
|
String[] |
resolveStringListValues(String[] value,
String nonexistentMacrosValue,
String listDelimiter,
ICConfigurationDescription cfg)
resolves macros in the array of string-list values
|
String |
resolveValue(String value,
String nonexistentMacrosValue,
String listDelimiter,
ICConfigurationDescription cfg)
resolves all macros in the string.
|
org.eclipse.core.variables.IStringVariable |
toEclipseVariable(ICdtVariable variable,
ICConfigurationDescription cfg) |
ICdtVariable getVariable(String name, ICConfigurationDescription cfg)
name
- macro nameICdtVariable[] getVariables(ICConfigurationDescription cfg)
String convertStringListToString(String[] value, String listDelimiter)
String resolveValue(String value, String nonexistentMacrosValue, String listDelimiter, ICConfigurationDescription cfg) throws CdtVariableException
value
- the value to be resolvednonexistentMacrosValue
- specifies the value that inexistent macro references will be
expanded to. If null the BuildMacroException is thrown in case the string to be resolved
references inexistent macroslistDelimiter
- if not null, StringList macros are expanded as
"CdtVariableException
String[] resolveStringListValue(String value, String nonexistentMacrosValue, String listDelimiter, ICConfigurationDescription cfg) throws CdtVariableException
CdtVariableException
String[] resolveStringListValues(String[] value, String nonexistentMacrosValue, String listDelimiter, ICConfigurationDescription cfg) throws CdtVariableException
boolean isStringListValue(String value, ICConfigurationDescription cfg) throws CdtVariableException
CdtVariableException
void checkVariableIntegrity(ICConfigurationDescription cfg) throws CdtVariableException
CdtVariableException
boolean isEnvironmentVariable(ICdtVariable variable, ICConfigurationDescription cfg)
boolean isUserVariable(ICdtVariable variable, ICConfigurationDescription cfg)
org.eclipse.core.variables.IStringVariable toEclipseVariable(ICdtVariable variable, ICConfigurationDescription cfg)
Copyright (c) IBM Corp. and others 2004, 2020. All Rights Reserved.