com.atlassian.bamboo.plugin.module.ext
Interface CustomBuildDefinitionGenerator

All Known Implementing Classes:

AutomaticDependencyManagementPlugin

public interface CustomBuildDefinitionGenerator

An interface that allows a plugin module to populate BuildDefinition object as it's created from BuildConfiguration. This allows you to put arbitrary objects into the custom objects map.

Method Summary

void	populateBuildDefinition(ImmutablePlan plan, java.util.Map<java.lang.String,java.lang.Object> configObjects, BuildDefinition buildDefinition) Implementors can add their custom objects to the configObjects map.

Method Detail

populateBuildDefinition

void populateBuildDefinition(@NotNull
                             ImmutablePlan plan,
                             @NotNull
                             java.util.Map<java.lang.String,java.lang.Object> configObjects,
                             @NotNull
                             BuildDefinition buildDefinition)

Implementors can add their custom objects to the configObjects map. The key should be unique to plugin... It's better to be descriptive. It is possible to also update the buildDefinition directly.

Parameters:

plan - ImmutablePlan whose BuildDefinition is being populated

configObjects - - Map - string key, object value. A map to put custom objects into. @NotNull

buildDefinition - - the fully constructed BuildDefinition @NotNull