VariableSubstitutionContext (Atlassian Bamboo 9.6.2 API)

All Superinterfaces:

Serializable, VariableDefinitionIdentifier

All Known Subinterfaces:

VariableBaselineItem, VariableContextSnapshot, VariableSubstitution

All Known Implementing Classes:

RestVariableSubstitutionContext, VariableBaselineItemImpl, VariableContextSnapshotImpl, VariableSubstitutionContextImpl, VariableSubstitutionImpl
```
@PublicApi
public interface VariableSubstitutionContext
extends VariableDefinitionIdentifier, Serializable
```
Light version of VariableSubstitution class, that could be passed to the agent inside BuildContext The purpose of this interface is to log usage of variables.
Agent code use this during variable substitution process

Field Summary
- Fields inherited from interface com.atlassian.bamboo.variable.VariableDefinitionIdentifier
  ORDERING

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getKey()`	Variable key as defined in UI
`String`	`getValue()`	Variable value
`VariableType`	`getVariableType()`	`VariableType` shows the source of variable value as it was evaluated before build execution
`void`	`setKey(String key)`
`void`	`setValue(String value)`
`void`	`setVariableType(VariableType variableType)`

- Method Detail
  - getKey
```
String getKey()
```
    Description copied from interface: VariableDefinitionIdentifier
    
    Variable key as defined in UI
    
    Specified by:
    
    getKey in interface VariableDefinitionIdentifier
    
    Returns:
    
    variable identifier
  - setKey
```
void setKey(String key)
```
  - getValue
```
String getValue()
```
    Description copied from interface: VariableDefinitionIdentifier
    
    Variable value
    
    Specified by:
    
    getValue in interface VariableDefinitionIdentifier
    
    Returns:
    
    variable value
  - setValue
```
void setValue(String value)
```
  - getVariableType
```
VariableType getVariableType()
```
    Description copied from interface: VariableDefinitionIdentifier
    
    VariableType shows the source of variable value as it was evaluated before build execution
    
    Specified by:
    
    getVariableType in interface VariableDefinitionIdentifier
    
    Returns:
    
    variable type
  - setVariableType
```
void setVariableType(VariableType variableType)
```