com.atlassian.jira.plugin.issuelink
Class IssueLinkRendererModuleDescriptorImpl
java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<IssueLinkRenderer>
com.atlassian.jira.plugin.issuelink.IssueLinkRendererModuleDescriptorImpl
- All Implemented Interfaces:
- IssueLinkRendererModuleDescriptor, JiraResourcedModuleDescriptor<IssueLinkRenderer>, com.atlassian.plugin.ModuleDescriptor<IssueLinkRenderer>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware
public class IssueLinkRendererModuleDescriptorImpl
- extends AbstractJiraModuleDescriptor<IssueLinkRenderer>
- implements IssueLinkRendererModuleDescriptor
Default implementation of an IssueLinkRendererModuleDescriptor
.
- Since:
- v5.0
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor |
moduleClass, moduleClassName, plugin, resources, singleton |
Methods inherited from class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor |
assertResourceExists, createModule, createVelocityParams, disabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, isResourceExist |
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor |
assertModuleClassImplements, destroy, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, satisfiesMinJavaVersion, setPlugin, toString |
Methods inherited from interface com.atlassian.plugin.ModuleDescriptor |
destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion |
Methods inherited from interface com.atlassian.plugin.Resourced |
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation |
XML_ELEMENT_NAME
public static final String XML_ELEMENT_NAME
- See Also:
- Constant Field Values
INITIAL_VIEW_RESOURCE_NAME
public static final String INITIAL_VIEW_RESOURCE_NAME
- See Also:
- Constant Field Values
FINAL_VIEW_RESOURCE_NAME
public static final String FINAL_VIEW_RESOURCE_NAME
- See Also:
- Constant Field Values
IssueLinkRendererModuleDescriptorImpl
public IssueLinkRendererModuleDescriptorImpl(JiraAuthenticationContext authenticationContext,
com.atlassian.plugin.module.ModuleFactory moduleFactory)
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<IssueLinkRenderer>
- Overrides:
init
in class AbstractJiraModuleDescriptor<IssueLinkRenderer>
- Throws:
com.atlassian.plugin.PluginParseException
enabled
public void enabled()
- Specified by:
enabled
in interface com.atlassian.plugin.StateAware
- Overrides:
enabled
in class AbstractJiraModuleDescriptor<IssueLinkRenderer>
provideValidationRules
protected void provideValidationRules(com.atlassian.plugin.util.validation.ValidationPattern pattern)
- Overrides:
provideValidationRules
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<IssueLinkRenderer>
isDefaultHandler
public boolean isDefaultHandler()
- Description copied from interface:
IssueLinkRendererModuleDescriptor
- Returns true if the module descriptor is the default handler for issue links.
- Specified by:
isDefaultHandler
in interface IssueLinkRendererModuleDescriptor
- Returns:
- true if the module descriptor is the default handler for issue links
handlesApplicationType
public boolean handlesApplicationType(String applicationType)
- Description copied from interface:
IssueLinkRendererModuleDescriptor
- Returns true if the module descriptor can handle the application type. Only one module descriptor should
be capable of handling an application type. If there are more than one modules that can handle an application
type, only the first module (in loading order) will be used. If no descriptors handle an application type, then
the default issue link renderer module descriptor is used (
IssueLinkRendererModuleDescriptor.isDefaultHandler()
.
- Specified by:
handlesApplicationType
in interface IssueLinkRendererModuleDescriptor
- Parameters:
applicationType
- application type to handle
- Returns:
- true if the module descriptor can handle the application type
getInitialHtml
public String getInitialHtml(RemoteIssueLink remoteIssueLink)
- Description copied from interface:
IssueLinkRendererModuleDescriptor
- Returns the initial HTML to place between the relationship text and the delete icon.
No remote calls should be made to construct the initial HTML.
- Specified by:
getInitialHtml
in interface IssueLinkRendererModuleDescriptor
- Parameters:
remoteIssueLink
- remote issue link
- Returns:
- initial HTML that goes between the relationship text and the delete icon
getFinalHtml
public String getFinalHtml(RemoteIssueLink remoteIssueLink)
- Description copied from interface:
IssueLinkRendererModuleDescriptor
- Returns the final HTML to place between the relationship text and the delete icon.
Remote calls may be made to construct the final HTML.
- Specified by:
getFinalHtml
in interface IssueLinkRendererModuleDescriptor
- Parameters:
remoteIssueLink
- remote issue link
- Returns:
- final HTML that goes between the relationship text and the delete icon
equals
public boolean equals(Object obj)
- Specified by:
equals
in interface com.atlassian.plugin.ModuleDescriptor<IssueLinkRenderer>
- Overrides:
equals
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<IssueLinkRenderer>
hashCode
public int hashCode()
- Specified by:
hashCode
in interface com.atlassian.plugin.ModuleDescriptor<IssueLinkRenderer>
- Overrides:
hashCode
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<IssueLinkRenderer>
Copyright © 2002-2012 Atlassian. All Rights Reserved.