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

All Known Implementing Classes:

BuildExpiryPerPlanPlugin, BuildMonitoringPerPlanPlugin

public interface CustomBuildDefinitionTransformer

An interface that allows a plugin module to transform a BuildDefinition object as it's be created from XML. This allows you to put arbitray objects into the custom objects map

Method Summary

void	transformBuildDefinition(java.util.Map<java.lang.String,java.lang.Object> configObjects, java.util.Map<java.lang.String,java.lang.String> configParameters, BuildDefinition buildDefinition) Implemtors can add their custom objects to the configObjects map.

Method Detail

transformBuildDefinition

void transformBuildDefinition(@NotNull
                              java.util.Map<java.lang.String,java.lang.Object> configObjects,
                              @NotNull
                              java.util.Map<java.lang.String,java.lang.String> configParameters,
                              @NotNull
                              BuildDefinition buildDefinition)

Implemtors can add their custom objects to the configObjects map. The key should be unqiue to plugin... It's better to be descriptive. It is possible to also updat the buildDefinition directly, but it's not recomended.

Parameters:

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

configParameters - - Map - String key, string value. These are taken from all fields that begin with "custom."

buildDefinition - - the fully contructed BuildDefinition @NotNull