public abstract class

AbstractJiraModuleDescriptor

extends AbstractModuleDescriptor<T>
implements JiraResourcedModuleDescriptor<T>
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<T>
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Base class for JIRA Plugin ModuleDescriptors.

Note: This class should not be considered as actually part of the API. It is in the jira-api module for legacy compatibility only.

Summary

[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Protected Constructors
AbstractJiraModuleDescriptor(JiraAuthenticationContext authenticationContext, ModuleFactory moduleFactory)
Public Methods
void disabled()
void enabled()
String getDescription()
String getHtml(String resourceName, Map<String, ?> startingParams)
String getHtml(String resourceName)
I18nHelper getI18nBean()
T getModule()
String getName()
String getText(String key, Object params)
@Deprecated String getText(String key)
This method is deprecated. Please use i18nBean.getText() instead. Since 5.0
void init(Plugin plugin, Element element)
void writeHtml(String resourceName, Map<String, ?> startingParams, Writer writer)
Protected Methods
void assertResourceExists(String type, String name)
T createModule()
Creates an instance of the Module.
Map<String, Object> createVelocityParams(Map<String, Object> startingParams)
JiraAuthenticationContext getAuthenticationContext()
ClassLoader getClassLoader()
boolean isResourceExist(String resourceName)
[Expand]
Inherited Methods
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware

Protected Constructors

protected AbstractJiraModuleDescriptor (JiraAuthenticationContext authenticationContext, ModuleFactory moduleFactory)

Public Methods

public void disabled ()

public void enabled ()

public String getDescription ()

public String getHtml (String resourceName, Map<String, ?> startingParams)

public String getHtml (String resourceName)

public I18nHelper getI18nBean ()

public T getModule ()

public String getName ()

public String getText (String key, Object params)

@Deprecated public String getText (String key)

This method is deprecated.
Please use i18nBean.getText() instead. Since 5.0

Parameters
key the property key
Returns
  • the translated text

public void init (Plugin plugin, Element element)

Throws
PluginParseException

public void writeHtml (String resourceName, Map<String, ?> startingParams, Writer writer)

Throws
IOException

Protected Methods

protected void assertResourceExists (String type, String name)

Throws
PluginParseException

protected T createModule ()

Creates an instance of the Module.

This is called by the lazy load logic of getModule() and is suitable for overriding in subclasses if they want to customize how the Module class is instantiated.

Returns
  • a new instance of the module.

protected Map<String, Object> createVelocityParams (Map<String, Object> startingParams)

protected JiraAuthenticationContext getAuthenticationContext ()

protected ClassLoader getClassLoader ()

protected boolean isResourceExist (String resourceName)