Package com.atlassian.jira.plugin.renderer

Class MacroModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<Object>
com.atlassian.jira.plugin.renderer.MacroModuleDescriptor
All Implemented Interfaces:
JiraResourcedModuleDescriptor<Object>, com.atlassian.plugin.ModuleDescriptor<Object>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
public class MacroModuleDescriptor extends AbstractJiraModuleDescriptor<Object>

  • Field Summary

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

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    MacroModuleDescriptor(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    createModule()
    Creates an instance of the Module.
    String
    getHelp()
     
    String
    getHelpSection()
     
    boolean
    hasHelp()
     

    Methods inherited from class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor

    assertResourceExists, createVelocityParams, disabled, enabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, init, isResourceExist, writeHtml

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

    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, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

    destroy, equals, getCompleteKey, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

    Methods inherited from interface com.atlassian.plugin.Resourced

    getResourceDescriptor, getResourceDescriptors, getResourceLocation

    Methods inherited from interface com.atlassian.plugin.ScopeAware

    getScopeKey

  • Constructor Details

    • MacroModuleDescriptor

      public MacroModuleDescriptor(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)

  • Method Details

    • createModule

      public Object createModule()
      Description copied from class: AbstractJiraModuleDescriptor
      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.

      Overrides:
      createModule in class AbstractJiraModuleDescriptor<Object>
      Returns:
      a new instance of the module.

    • hasHelp

      public boolean hasHelp()

    • getHelpSection

      public String getHelpSection()

    • getHelp

      public String getHelp()