com.atlassian.bamboo.plugin.descriptor
Class TaskModuleDescriptorImpl

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor<InternalTaskType>
          com.atlassian.bamboo.plugin.descriptor.TaskModuleDescriptorImpl

All Implemented Interfaces:

TaskModuleDescriptor, NameProvider, com.atlassian.plugin.ModuleDescriptor<InternalTaskType>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, java.io.Serializable

public final class TaskModuleDescriptorImpl
extends AbstractBambooModuleDescriptor<InternalTaskType>
implements TaskModuleDescriptor, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

TaskModuleDescriptorImpl(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

void	disabled()
CapabilityDefaultsHelper	getCapabilityDefaultsHelper() Retrieves the instance responsible for detecting the default Capabilitys of this plugin
java.util.List<TaskCategory>	getCategories()
TaskHelpLink	getHelpLink() TaskHelpLink objects contain the i18n keys which can be used to find help urls for tasks and their corresponding titles.
java.lang.String	getIconUrl() URL to the icon to be used in the Task browser
RuntimeTaskDataProvider	getRuntimeTaskDataProvider() Optional server side component allowing inject runtime parameters for task
TaskConfigurator	getTaskConfigurator() Retrieves the plugin class responsible fo handling user configuration of this plugin.
java.util.List<TaskExecutableType>	getTaskExecutables()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

Methods inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor

getElementAsString, getFreeMarkerResourceLocation, getModule, getVelocityResourceLocation, instantiateClass, isMutable, postInit, preInit

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.bamboo.utils.NameProvider

getName

Constructor Detail

TaskModuleDescriptorImpl

public TaskModuleDescriptorImpl(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<InternalTaskType>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<InternalTaskType>

Throws:

com.atlassian.plugin.PluginParseException

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class AbstractBambooModuleDescriptor<InternalTaskType>

getCapabilityDefaultsHelper

public CapabilityDefaultsHelper getCapabilityDefaultsHelper()

Description copied from interface: TaskModuleDescriptor

Retrieves the instance responsible for detecting the default Capabilitys of this plugin

Specified by:

getCapabilityDefaultsHelper in interface TaskModuleDescriptor

Returns:

CapabilityDefaultsHelper for this TaskType

getTaskConfigurator

@Nullable
public TaskConfigurator getTaskConfigurator()

Description copied from interface: TaskModuleDescriptor

Retrieves the plugin class responsible fo handling user configuration of this plugin.

Specified by:

getTaskConfigurator in interface TaskModuleDescriptor

Returns:

TaskConfigurator for this TaskType

getCategories

@NotNull
public java.util.List<TaskCategory> getCategories()

Specified by:

getCategories in interface TaskModuleDescriptor

Returns:

a list of TaskCategorys that this module belongs to

getTaskExecutables

@NotNull
public java.util.List<TaskExecutableType> getTaskExecutables()

Specified by:

getTaskExecutables in interface TaskModuleDescriptor

Returns:

details for TaskType executable

getIconUrl

public java.lang.String getIconUrl()

Description copied from interface: TaskModuleDescriptor

URL to the icon to be used in the Task browser

Specified by:

getIconUrl in interface TaskModuleDescriptor

Returns:

url to the resource named 'icon' with the type 'download'

getHelpLink

@Nullable
public TaskHelpLink getHelpLink()

Description copied from interface: TaskModuleDescriptor

TaskHelpLink objects contain the i18n keys which can be used to find help urls for tasks and their corresponding titles.

Specified by:

getHelpLink in interface TaskModuleDescriptor

Returns:

TaskHelpLink object

getRuntimeTaskDataProvider

@Nullable
public RuntimeTaskDataProvider getRuntimeTaskDataProvider()

Description copied from interface: TaskModuleDescriptor

Optional server side component allowing inject runtime parameters for task

Specified by:

getRuntimeTaskDataProvider in interface TaskModuleDescriptor

Returns: