com.atlassian.bamboo.chains.plugins
Class AbstractChainConfigurationPanel

java.lang.Object
  com.atlassian.bamboo.chains.plugins.AbstractChainConfigurationPanel

All Implemented Interfaces:

ChainConfigurationPanel, ConvertibleFromConfig, InitablePluginModule, BambooPluginModule, ConfigurablePlugin

public abstract class AbstractChainConfigurationPanel
extends java.lang.Object
implements ChainConfigurationPanel

Constructor Summary

AbstractChainConfigurationPanel()

Method Summary

void	customizeBuildRequirements(BuildConfiguration buildConfiguration, RequirementSet requirementSet) Extension point for adding/customizing requirements when editing a build's builder configuration.
java.lang.String	getEditHtml(BuildConfiguration buildConfiguration, Plan plan) Returns HTML that represents the form fragment for editing the repository.
java.lang.String	getKey()
java.lang.String	getTitle()
java.lang.String	getTitleKey()
java.lang.String	getViewHtml(Plan plan) Returns the HTML that represents the view of the repository configuration
void	init(com.atlassian.plugin.ModuleDescriptor moduleDescriptor) Initialises the Plugin with the plugin module descriptor
protected void	populateContextForEdit(java.util.Map<java.lang.String,java.lang.Object> context, BuildConfiguration buildConfiguration, Plan plan)
protected void	populateContextForView(java.util.Map<java.lang.String,java.lang.Object> context, Plan plan)
void	removeBuildRequirements(BuildConfiguration buildConfiguration, RequirementSet requirementSet) Extension point for removing requirements when given plugin is excluded from build's builder configuration.
void	setKey(java.lang.String key)
void	setTemplateRenderer(TemplateRenderer templateRenderer)
void	setTitle(java.lang.String title)
void	setTitleKey(java.lang.String titleKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.v2.build.ConfigurablePlugin

addDefaultValues, prepareConfigObject, validate

Methods inherited from interface com.atlassian.bamboo.fieldvalue.ConvertibleFromConfig

populateFromConfig, toConfiguration

Constructor Detail

AbstractChainConfigurationPanel

public AbstractChainConfigurationPanel()

Method Detail

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface ChainConfigurationPanel

setTitle

public void setTitle(java.lang.String title)

Specified by:

setTitle in interface ChainConfigurationPanel

getTitleKey

public java.lang.String getTitleKey()

Specified by:

getTitleKey in interface ChainConfigurationPanel

setTitleKey

public void setTitleKey(java.lang.String titleKey)

Specified by:

setTitleKey in interface ChainConfigurationPanel

getKey

public java.lang.String getKey()

Specified by:

getKey in interface ChainConfigurationPanel

setKey

public void setKey(java.lang.String key)

Specified by:

setKey in interface ChainConfigurationPanel

getViewHtml

@Nullable
public java.lang.String getViewHtml(@NotNull
                                             Plan plan)

Description copied from interface: ConfigurablePlugin

Returns the HTML that represents the view of the repository configuration

Specified by:

getViewHtml in interface ConfigurablePlugin

Returns:

HTML string. May be null.

populateContextForView

protected void populateContextForView(@NotNull
                                      java.util.Map<java.lang.String,java.lang.Object> context,
                                      @NotNull
                                      Plan plan)

getEditHtml

@Nullable
public java.lang.String getEditHtml(@NotNull
                                             BuildConfiguration buildConfiguration,
                                             @NotNull
                                             Plan plan)

Description copied from interface: ConfigurablePlugin

Returns HTML that represents the form fragment for editing the repository. No opening and closing form tags are required.

Specified by:

getEditHtml in interface ConfigurablePlugin

Parameters:

buildConfiguration - BuildConfiguration for which edit HTML has to be rendered.

Returns:

HTML string. May be null.

populateContextForEdit

protected void populateContextForEdit(@NotNull
                                      java.util.Map<java.lang.String,java.lang.Object> context,
                                      @NotNull
                                      BuildConfiguration buildConfiguration,
                                      @NotNull
                                      Plan plan)

removeBuildRequirements

public void removeBuildRequirements(@NotNull
                                    BuildConfiguration buildConfiguration,
                                    @NotNull
                                    RequirementSet requirementSet)

Description copied from interface: ConfigurablePlugin

Extension point for removing requirements when given plugin is excluded from build's builder configuration.

Specified by:

removeBuildRequirements in interface ConfigurablePlugin

Parameters:

buildConfiguration - source of information for customizing build requirements

requirementSet - requirements to be customized

customizeBuildRequirements

public void customizeBuildRequirements(@NotNull
                                       BuildConfiguration buildConfiguration,
                                       @NotNull
                                       RequirementSet requirementSet)

Description copied from interface: ConfigurablePlugin

Extension point for adding/customizing requirements when editing a build's builder configuration.

Specified by:

customizeBuildRequirements in interface ConfigurablePlugin

Parameters:

buildConfiguration - source of information for customizing build requirements

requirementSet - requirements to be customized

init

public void init(@NotNull
                 com.atlassian.plugin.ModuleDescriptor moduleDescriptor)

Description copied from interface: InitablePluginModule

Initialises the Plugin with the plugin module descriptor

Specified by:

init in interface InitablePluginModule

Parameters:

moduleDescriptor - Plugin module descriptor

setTemplateRenderer

public void setTemplateRenderer(TemplateRenderer templateRenderer)