com.atlassian.bamboo.plugin.web

Class PlanConfigurationPluginUIHelperImpl

java.lang.Object

com.atlassian.bamboo.plugin.web.PlanConfigurationPluginUIHelperImpl

All Implemented Interfaces:

PlanConfigurationUIPluginHelper

public class PlanConfigurationPluginUIHelperImpl
extends Object
implements PlanConfigurationUIPluginHelper

Constructor Summary

Constructors

Constructor and Description
PlanConfigurationPluginUIHelperImpl(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

Modifier and Type	Method and Description
<T extends BuildConfigurationAwarePlugin> Iterable<T>	getBuildConfigurationPlugins(Plan plan, Class<T> pluginClass) Find all installed plugins of a given class.
<T extends BuildConfigurationAwarePlugin> Iterable<T>	getBuildConfigurationPlugins(Plan plan, Class<T> pluginClass, Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses) Find all installed plugins of a given class and module descriptor.
<T extends BuildConfigurationAwarePlugin> String	getEditHtml(BuildConfiguration buildConfiguration, Plan plan, Class<T> pluginClass) Generate html page from all plugin edit fragments.
<T extends BuildConfigurationAwarePlugin> List<String>	getEditHtmlList(BuildConfiguration buildConfiguration, Plan plan, Class<T> pluginClass, Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses) Generate list of html edit fragments for all plugins.
List<Class>	getModuleTypesOnJobPage()
<T extends BuildConfigurationAwarePlugin> String	getViewHtml(Plan plan, Class<T> pluginClass) Generate html page from all plugin view fragments.
<T extends BuildConfigurationAwarePlugin> List<String>	getViewHtmlList(Plan plan, Class<T> pluginClass, Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses) Generate list of html view fragments for all plugins.
boolean	isPluginApplicableTo(BuildConfigurationAwarePlugin module, ImmutablePlan immutablePlan) Return true if a plugin module should be displayed on given plan''s "miscellaneous" page.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanConfigurationPluginUIHelperImpl

public PlanConfigurationPluginUIHelperImpl(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

getBuildConfigurationPlugins

@NotNull
public <T extends BuildConfigurationAwarePlugin> Iterable<T> getBuildConfigurationPlugins(@NotNull
                                                                                                   Plan plan,
                                                                                                   @NotNull
                                                                                                   Class<T> pluginClass)

Description copied from interface: PlanConfigurationUIPluginHelper

Find all installed plugins of a given class. If plugins implement BuildConfigurationUIPlugin, plugins will be checked for applicability to the plan.

Specified by:

getBuildConfigurationPlugins in interface PlanConfigurationUIPluginHelper

Parameters:

plan - Plan to be checked with plugins

pluginClass - requested plugin class

Returns:

Iterable of filtered plugins

getBuildConfigurationPlugins

@NotNull
public <T extends BuildConfigurationAwarePlugin> Iterable<T> getBuildConfigurationPlugins(@NotNull
                                                                                                   Plan plan,
                                                                                                   @NotNull
                                                                                                   Class<T> pluginClass,
                                                                                                   @NotNull
                                                                                                   Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)

Description copied from interface: PlanConfigurationUIPluginHelper

Find all installed plugins of a given class and module descriptor. If plugins implement BuildConfigurationUIPlugin, plugins will be checked for applicability to the plan.

Specified by:

getBuildConfigurationPlugins in interface PlanConfigurationUIPluginHelper

Parameters:

plan - Plan to be checked with plugins

pluginClass - requested plugin class

moduleDescriptorsClasses - plugin descriptors

Returns:

Iterable of filtered plugins

getViewHtml

@NotNull
public <T extends BuildConfigurationAwarePlugin> String getViewHtml(@NotNull
                                                                             Plan plan,
                                                                             @NotNull
                                                                             Class<T> pluginClass)

Description copied from interface: PlanConfigurationUIPluginHelper

Generate html page from all plugin view fragments.

Specified by:

getViewHtml in interface PlanConfigurationUIPluginHelper

Parameters:

plan - Plan to be used for HTML generation

pluginClass - requested plugin class

Returns:

Aggregated HTML page for view

getEditHtml

@NotNull
public <T extends BuildConfigurationAwarePlugin> String getEditHtml(@NotNull
                                                                             BuildConfiguration buildConfiguration,
                                                                             @NotNull
                                                                             Plan plan,
                                                                             @NotNull
                                                                             Class<T> pluginClass)

Description copied from interface: PlanConfigurationUIPluginHelper

Generate html page from all plugin edit fragments.

Specified by:

getEditHtml in interface PlanConfigurationUIPluginHelper

Parameters:

buildConfiguration - BuildConfiguration to be used for HTML generation

plan - Plan to be used for HTML generation

pluginClass - requested plugin class

Returns:

Aggregated HTML page for edit.

getViewHtmlList

@NotNull
public <T extends BuildConfigurationAwarePlugin> List<String> getViewHtmlList(@NotNull
                                                                                       Plan plan,
                                                                                       @NotNull
                                                                                       Class<T> pluginClass,
                                                                                       @NotNull
                                                                                       Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)

Description copied from interface: PlanConfigurationUIPluginHelper

Generate list of html view fragments for all plugins.

Specified by:

getViewHtmlList in interface PlanConfigurationUIPluginHelper

Parameters:

plan - Plan to be used for HTML generation

pluginClass - requested plugin class

moduleDescriptorsClasses - plugin descriptors

Returns:

HTML fragments for view.

getEditHtmlList

@NotNull
public <T extends BuildConfigurationAwarePlugin> List<String> getEditHtmlList(@NotNull
                                                                                       BuildConfiguration buildConfiguration,
                                                                                       @NotNull
                                                                                       Plan plan,
                                                                                       @NotNull
                                                                                       Class<T> pluginClass,
                                                                                       @NotNull
                                                                                       Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)

Description copied from interface: PlanConfigurationUIPluginHelper

Generate list of html edit fragments for all plugins.

Specified by:

getEditHtmlList in interface PlanConfigurationUIPluginHelper

Parameters:

buildConfiguration - BuildConfiguration to be used for HTML generation

plan - Plan to be used for HTML generation

pluginClass - requested plugin class

moduleDescriptorsClasses - plugin descriptors

Returns:

HTML fragments for edit

isPluginApplicableTo

public boolean isPluginApplicableTo(BuildConfigurationAwarePlugin module,
                                    ImmutablePlan immutablePlan)

Description copied from interface: PlanConfigurationUIPluginHelper

Return true if a plugin module should be displayed on given plan''s "miscellaneous" page.

Specified by:

isPluginApplicableTo in interface PlanConfigurationUIPluginHelper

getModuleTypesOnJobPage

public List<Class> getModuleTypesOnJobPage()

Specified by:

getModuleTypesOnJobPage in interface PlanConfigurationUIPluginHelper