Package com.atlassian.bamboo.build.artifact

Class ArtifactHandlerForPlanConfigurator

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.build.artifact.ArtifactHandlerForPlanConfigurator

All Implemented Interfaces:

MiscellaneousPlanConfigurationPlugin, PlanConfigurationUiPlugin, InitablePluginModule, BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, RenderableBuildConfiguration

public class ArtifactHandlerForPlanConfigurator
extends BaseConfigurablePlugin
implements MiscellaneousPlanConfigurationPlugin

Field Summary

Fields

Modifier and Type	Field	Description
static final String	USE_CUSTOM_ARTIFACT_HANDLERS

Fields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

moduleDescriptor, templateRenderer

Constructor Summary

Constructors

Constructor	Description
ArtifactHandlerForPlanConfigurator()

Method Summary

Modifier and Type	Method	Description
@NotNull Set<String>	getConfigurationKeys()
@Nullable String	getEditHtml()
String	getEditHtml(@NotNull BuildConfiguration buildConfiguration, @Nullable Plan plan)	Returns HTML that represents the form fragment for editing the repository.
MiscellaneousBuildConfigurationModuleDescriptor	getModuleDescriptor()
boolean	isApplicableTo(@NotNull ImmutablePlan plan)	Checks if the plugin is applicable to a plan.

Methods inherited from class com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

customizeBuildRequirements, removeBuildRequirements

Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

addDefaultValues, getTemplateRenderer, getViewHtml, init, populateContextForEdit, populateContextForView, prepareConfigObject, setTemplateRenderer, validate

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.BuildConfigurationAwarePlugin

addDefaultValues, isConfigurationMissing, prepareConfigObject, validate

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule

init

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

getViewHtml

Field Details

USE_CUSTOM_ARTIFACT_HANDLERS

public static final String USE_CUSTOM_ARTIFACT_HANDLERS

See Also:

• Constant Field Values

Constructor Details

ArtifactHandlerForPlanConfigurator

public ArtifactHandlerForPlanConfigurator()

Method Details

isApplicableTo

public boolean isApplicableTo(@NotNull
 @NotNull ImmutablePlan plan)

Description copied from interface: PlanConfigurationUiPlugin

Checks if the plugin is applicable to a plan. Typical implementation is to check plan's type (chain, build, job).

Specified by:

isApplicableTo in interface PlanConfigurationUiPlugin

Parameters:

plan - Plan to be verified

Returns:

true if particular configuration is applicable to input plan

getEditHtml

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

Description copied from interface: RenderableBuildConfiguration

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

Specified by:

getEditHtml in interface RenderableBuildConfiguration

Overrides:

getEditHtml in class BaseBuildConfigurationAwarePlugin

Parameters:

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

plan - Plan for which edit HTML has to be rendered. May be null during creation phase of plan.

Returns:

HTML string. May be null.

getEditHtml

@Nullable
public @Nullable String getEditHtml()

getModuleDescriptor

public MiscellaneousBuildConfigurationModuleDescriptor getModuleDescriptor()

getConfigurationKeys

@NotNull
public @NotNull Set<String> getConfigurationKeys()