com.atlassian.jira.plugin.webfragment.descriptors

Class DefaultSimpleLinkFactoryModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<SimpleLinkFactory>

com.atlassian.jira.plugin.webfragment.descriptors.DefaultSimpleLinkFactoryModuleDescriptor

All Implemented Interfaces:

JiraResourcedModuleDescriptor<SimpleLinkFactory>, SimpleLinkFactoryModuleDescriptor, com.atlassian.plugin.ModuleDescriptor<SimpleLinkFactory>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.descriptors.WeightedDescriptor

public class DefaultSimpleLinkFactoryModuleDescriptor
extends AbstractJiraModuleDescriptor<SimpleLinkFactory>
implements SimpleLinkFactoryModuleDescriptor

Plugin in Module descriptor that defines a SimpleLinkFactory. This is used by the SimpleLinkManager to display a list of simple links. The special attributes for this are: lazy - whether the section should be loaded lazily, weight - the position to include the generated list, and section - the section that the generated links go into.

Since:

v4.0

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
DefaultSimpleLinkFactoryModuleDescriptor(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
String	getSection() The section that this list will be inserted into.
int	getWeight()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	shouldBeLazy() Whether or not this should be lazily loaded.

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

assertResourceExists, createModule, createVelocityParams, disabled, enabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, 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, provideValidationRules, satisfiesMinJavaVersion, setBroken, 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, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Constructor Detail

DefaultSimpleLinkFactoryModuleDescriptor

public DefaultSimpleLinkFactoryModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                                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<SimpleLinkFactory>

Overrides:

init in class AbstractJiraModuleDescriptor<SimpleLinkFactory>

Throws:

com.atlassian.plugin.PluginParseException

shouldBeLazy

public boolean shouldBeLazy()

Description copied from interface: SimpleLinkFactoryModuleDescriptor

Whether or not this should be lazily loaded. This should be true if the list is expensive. Note that this can be ignored if the list does not support lazily loaded links.

Specified by:

shouldBeLazy in interface SimpleLinkFactoryModuleDescriptor

Returns:

true if the list is expensive to generate and should be loaded lazily if possible, false otherwise.

getWeight

public int getWeight()

Specified by:

getWeight in interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

getSection

public String getSection()

Description copied from interface: SimpleLinkFactoryModuleDescriptor

The section that this list will be inserted into. This usually refers to a WebSectionModuleDescriptor location + "/" + key.

This should never return null.

Specified by:

getSection in interface SimpleLinkFactoryModuleDescriptor

Returns:

The section that this list will be inserted into.