com.atlassian.bamboo.resultsummary.variables

Interface ResultsSummaryVariableAccessor

All Known Implementing Classes:

ResultsSummaryVariableAccessorImpl

public interface ResultsSummaryVariableAccessor

Method Summary

Modifier and Type	Method and Description
Map<String,VariableDefinitionContext>	calculateCurrentVariablesState(PlanResultKey chainResultKey) Get state of variables at point when execution of the build stopped.
Map<String,VariableDefinitionContext>	calculateInitialVariablesState(PlanResultKey chainResultKey) Get state of variables as recorded at the start of the build.
List<VariableDefinitionContext>	getManualVariables(ChainResultsSummary resultsSummary) Get manual variables state from start of this chain result.
List<VariableDefinitionContext>	getVariableStateForJobResult(BuildResultsSummary resultsSummary) Get state of all variables at the end of the job.
VariableContextBaseline	safeGetVariableContextBaseline(PlanResultKey chainResultKey)
void	upgradeVariableDataIfNeeded(PlanResultKey chainResultKey) Deprecated. internal use only

Method Detail

calculateInitialVariablesState

@NotNull
Map<String,VariableDefinitionContext> calculateInitialVariablesState(@NotNull
                                                                              PlanResultKey chainResultKey)

Get state of variables as recorded at the start of the build. Includes snapshot of plan and global variables, as well as manual variables set at the start of the build.

Parameters:

chainResultKey -

Returns:

calculateCurrentVariablesState

@NotNull
Map<String,VariableDefinitionContext> calculateCurrentVariablesState(@NotNull
                                                                              PlanResultKey chainResultKey)

Get state of variables at point when execution of the build stopped. Includes initial state of variables modified with all result variables from successful stages and all the variables set at started manual stages. If all stages of chain are complete this is basically final state of the variables.

Parameters:

chainResultKey -

Returns:

safeGetVariableContextBaseline

@Nullable
VariableContextBaseline safeGetVariableContextBaseline(@NotNull
                                                                 PlanResultKey chainResultKey)

getManualVariables

@NotNull
List<VariableDefinitionContext> getManualVariables(@NotNull
                                                            ChainResultsSummary resultsSummary)

Get manual variables state from start of this chain result.

Since:

5.15

getVariableStateForJobResult

@NotNull
List<VariableDefinitionContext> getVariableStateForJobResult(BuildResultsSummary resultsSummary)

Get state of all variables at the end of the job.

Parameters:

resultsSummary - job result

Since:

5.15

upgradeVariableDataIfNeeded

@Deprecated
 @Nullable
void upgradeVariableDataIfNeeded(@NotNull
                                                        PlanResultKey chainResultKey)

Deprecated. internal use only

Parameters:

chainResultKey -