Package com.atlassian.bamboo.variable

Interface VariableDefinitionContext

All Superinterfaces:

Serializable, VariableDefinitionIdentifier

All Known Subinterfaces:

StageVariableContext, VariableDefinition

All Known Implementing Classes:

StageVariableContextImpl, SubstitutedVariableDefinitionContextImpl, VariableDefinitionContextImpl, VariableDefinitionImpl

@PublicApi
public interface VariableDefinitionContext
extends VariableDefinitionIdentifier, Serializable

Light version of VariableDefinition class, that could be passed to the agent inside BuildContext The purpose of this interface is to pass currently evaluated variable context. Agent code use this during variable substitution process

Field Summary

Fields inherited from interface com.atlassian.bamboo.variable.VariableDefinitionIdentifier

ORDERING

Method Summary

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

Method Detail

getKey

@NotNull
@NotNull String getKey()

Variable key as defined in UI

Specified by:

getKey in interface VariableDefinitionIdentifier

Returns:

variable key

setKey

void setKey(String key)

getValue

@NotNull
@NotNull String getValue()

Variable value as set in UI

Specified by:

getValue in interface VariableDefinitionIdentifier

Returns:

setValue

void setValue(@NotNull
              @NotNull String value)

getVariableType

VariableType getVariableType()

VariableType shows the source of variable value as it was evaluated before build execution

Specified by:

getVariableType in interface VariableDefinitionIdentifier

Returns:

setVariableType

void setVariableType(VariableType variableType)