T
- The Plugin interface for this ModuleDescriptor.public abstract class AbstractJiraModuleDescriptor<T> extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T> implements JiraResourcedModuleDescriptor<T>
Note: This class should not be considered as actually part of the API. It is in the jira-api module for legacy compatibility only.
Modifier | Constructor and Description |
---|---|
protected |
AbstractJiraModuleDescriptor(JiraAuthenticationContext authenticationContext,
com.atlassian.plugin.module.ModuleFactory moduleFactory) |
Modifier and Type | Method and Description |
---|---|
protected void |
assertResourceExists(String type,
String name) |
protected T |
createModule()
Creates an instance of the Module.
|
protected Map<String,Object> |
createVelocityParams(Map<String,Object> startingParams) |
void |
disabled() |
void |
enabled() |
protected JiraAuthenticationContext |
getAuthenticationContext() |
protected ClassLoader |
getClassLoader() |
String |
getDescription() |
String |
getHtml(String resourceName) |
String |
getHtml(String resourceName,
Map<String,?> startingParams) |
I18nHelper |
getI18nBean() |
T |
getModule() |
String |
getName() |
String |
getText(String key)
Deprecated.
Please use i18nBean.getText() instead. Since 5.0
|
String |
getText(String key,
Object params) |
void |
init(com.atlassian.plugin.Plugin plugin,
org.dom4j.Element element) |
protected boolean |
isResourceExist(String resourceName) |
void |
writeHtml(String resourceName,
Map<String,?> startingParams,
Writer writer) |
assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
destroy, equals, getCompleteKey, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken
protected AbstractJiraModuleDescriptor(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)
public void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element) throws com.atlassian.plugin.PluginParseException
protected void assertResourceExists(String type, String name) throws com.atlassian.plugin.PluginParseException
com.atlassian.plugin.PluginParseException
public String getHtml(String resourceName)
getHtml
in interface JiraResourcedModuleDescriptor<T>
public String getHtml(String resourceName, Map<String,?> startingParams)
getHtml
in interface JiraResourcedModuleDescriptor<T>
public void writeHtml(String resourceName, Map<String,?> startingParams, Writer writer) throws IOException
writeHtml
in interface JiraResourcedModuleDescriptor<T>
IOException
public T getModule()
protected T createModule()
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.
public String getDescription()
public String getName()
protected JiraAuthenticationContext getAuthenticationContext()
@Deprecated public String getText(String key)
key
- the property keypublic I18nHelper getI18nBean()
getI18nBean
in interface JiraResourcedModuleDescriptor<T>
protected Map<String,Object> createVelocityParams(Map<String,Object> startingParams)
protected boolean isResourceExist(String resourceName)
protected ClassLoader getClassLoader()
public void enabled()
enabled
in interface com.atlassian.plugin.StateAware
enabled
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
public void disabled()
disabled
in interface com.atlassian.plugin.StateAware
disabled
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
Copyright © 2002-2021 Atlassian. All Rights Reserved.