com.atlassian.jira.plugin.issuelink
Class AbstractIssueLinkRenderer
java.lang.Object
com.atlassian.jira.plugin.issuelink.AbstractIssueLinkRenderer
- All Implemented Interfaces:
- IssueLinkRenderer
- Direct Known Subclasses:
- DefaultIssueLinkRenderer
@PublicSpi
public abstract class AbstractIssueLinkRenderer
- extends Object
- implements IssueLinkRenderer
Base class for an issue link renderer that does not perform any asynchronous rendering of an issue link and will
always display the issue link.
- Since:
- v5.0
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
AbstractIssueLinkRenderer
public AbstractIssueLinkRenderer()
getFinalContext
public Map<String,Object> getFinalContext(RemoteIssueLink remoteIssueLink,
Map<String,Object> context)
- Refer to documentation in
IssueLinkRenderer.getFinalContext(com.atlassian.jira.issue.link.RemoteIssueLink, java.util.Map)
.
Subclasses requiring asynchronous loading should override this method, otherwise this method will always throw an
UnsupportedOperationException
.
- Specified by:
getFinalContext
in interface IssueLinkRenderer
- Parameters:
remoteIssueLink
- remote issue linkcontext
- the contextual information that can be used during rendering.
- Returns:
- velocity context used to render the final HTML
requiresAsyncLoading
public boolean requiresAsyncLoading(RemoteIssueLink remoteIssueLink)
- Refer to documentation in
IssueLinkRenderer.requiresAsyncLoading(com.atlassian.jira.issue.link.RemoteIssueLink)
.
Subclasses requiring asynchronous loading should override this method and return true, otherwise this
method will always return false.
- Specified by:
requiresAsyncLoading
in interface IssueLinkRenderer
- Parameters:
remoteIssueLink
- remote issue link
- Returns:
- false by default
shouldDisplay
public boolean shouldDisplay(RemoteIssueLink remoteIssueLink)
- Refer to documentation in
IssueLinkRenderer.shouldDisplay(com.atlassian.jira.issue.link.RemoteIssueLink)
.
- Specified by:
shouldDisplay
in interface IssueLinkRenderer
- Parameters:
remoteIssueLink
- remote issue link
- Returns:
- true by default
Copyright © 2002-2014 Atlassian. All Rights Reserved.