|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.bamboo.v2.build.BaseConfigurablePlugin
public abstract class BaseConfigurablePlugin
Helper class that allows you to
Field Summary | |
---|---|
protected com.atlassian.plugin.ModuleDescriptor |
moduleDescriptor
|
protected TemplateRenderer |
templateRenderer
|
Constructor Summary | |
---|---|
BaseConfigurablePlugin()
|
Method Summary | |
---|---|
void |
addDefaultValues(BuildConfiguration buildConfiguration)
Extension point for adding default values to the form for #getEditHtml() |
void |
customizeBuildRequirements(BuildConfiguration buildConfiguration,
RequirementSet requirementSet)
Extension point for adding/customizing requiremnents when editing a build's builder configuration. |
java.lang.String |
getEditHtml(BuildConfiguration buildConfiguration,
Build build)
Returns HTML that represents the form fragment for editing the repository. |
java.lang.String |
getViewHtml(Build build)
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,
Build build)
|
protected void |
populateContextForView(java.util.Map<java.lang.String,java.lang.Object> context,
Build build)
|
void |
prepareConfigObject(BuildConfiguration buildConfiguration)
Do any preprocessing work before validation occurs |
void |
setTemplateRenderer(TemplateRenderer templateRenderer)
|
ErrorCollection |
validate(BuildConfiguration buildConfiguration)
Validates the properties in the BuildConfiguration object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected TemplateRenderer templateRenderer
protected com.atlassian.plugin.ModuleDescriptor moduleDescriptor
Constructor Detail |
---|
public BaseConfigurablePlugin()
Method Detail |
---|
public void init(@NotNull com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
ConfigurablePlugin
init
in interface ConfigurablePlugin
public void addDefaultValues(@NotNull BuildConfiguration buildConfiguration)
ConfigurablePlugin
#getEditHtml()
addDefaultValues
in interface ConfigurablePlugin
buildConfiguration
- - @NotNullpublic void prepareConfigObject(@NotNull BuildConfiguration buildConfiguration)
ConfigurablePlugin
prepareConfigObject
in interface ConfigurablePlugin
buildConfiguration
- - @NotNull@NotNull public ErrorCollection validate(@NotNull BuildConfiguration buildConfiguration)
ConfigurablePlugin
BuildConfiguration
object. The name of the properties match those passed
in through the form fragments in #getEditHtml()
template.
validate
in interface ConfigurablePlugin
buildConfiguration
- - @NotNull
ErrorCollection
keyed by the field name. @NotNullpublic void customizeBuildRequirements(@NotNull BuildConfiguration buildConfiguration, @NotNull RequirementSet requirementSet)
ConfigurablePlugin
customizeBuildRequirements
in interface ConfigurablePlugin
@Nullable public java.lang.String getViewHtml(@NotNull Build build)
ConfigurablePlugin
getViewHtml
in interface ConfigurablePlugin
protected void populateContextForView(@NotNull java.util.Map<java.lang.String,java.lang.Object> context, @NotNull Build build)
@Nullable public java.lang.String getEditHtml(@NotNull BuildConfiguration buildConfiguration, @NotNull Build build)
ConfigurablePlugin
getEditHtml
in interface ConfigurablePlugin
protected void populateContextForEdit(@NotNull java.util.Map<java.lang.String,java.lang.Object> context, @NotNull BuildConfiguration buildConfiguration, @NotNull Build build)
public void setTemplateRenderer(TemplateRenderer templateRenderer)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |