com.atlassian.renderer.links

Class UnresolvedLink

java.lang.Object

com.atlassian.renderer.links.Link

com.atlassian.renderer.links.UnresolvedLink

public class UnresolvedLink
extends Link

A link that should not be rendered as a link, either because it

• attempts to point somewhere that doesn't exist
• points somewhere the user has no access to
• is the result of a parse error

Field Summary

Fields inherited from class com.atlassian.renderer.links.Link

aliasSpecified, iconName, linkBody, relativeUrl, title, titleArgs, titleKey, url, wikiDestination, wikiTitle

Constructor Summary

Constructors

Constructor and Description
UnresolvedLink(String originalLinkText)
UnresolvedLink(String originalLinkText, Link unresolvedLink)
UnresolvedLink(String originalLinkText, String linkBody)

Method Summary

Methods

Modifier and Type	Method and Description
String	getTitle() Get the link title text
List	getTitleArgs() Retrieves the arguments to use in the internationalised message identified by Link.getTitleKey()
String	getTitleKey() Retrieve the i18n key for the title if defined.
String	getUrl() Get the destination URL for this link.
String	getWikiDestination() Gets the destination portion of the Link.originalLinkText.
String	getWikiTitle() Gets the optional title portion of the Link.originalLinkText.
boolean	isAliasSpecified() Returns true if the link markup specifies an alias.
boolean	isRelativeUrl() Is the URL relativeUrl to the application's context path?

Methods inherited from class com.atlassian.renderer.links.Link

equals, getIconName, getLinkAttributes, getLinkBody, getOriginalLinkText, getUnpermittedLinkBody, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

UnresolvedLink

public UnresolvedLink(String originalLinkText)

UnresolvedLink

public UnresolvedLink(String originalLinkText,
              String linkBody)

UnresolvedLink

public UnresolvedLink(String originalLinkText,
              Link unresolvedLink)

Method Detail

isRelativeUrl

public boolean isRelativeUrl()

Description copied from class: Link

Is the URL relativeUrl to the application's context path?

Overrides:

isRelativeUrl in class Link

Returns:

true if the URL is relativeUrl to the context path.

getTitle

public String getTitle()

Description copied from class: Link

Get the link title text

Overrides:

getTitle in class Link

getTitleKey

public String getTitleKey()

Description copied from class: Link

Retrieve the i18n key for the title if defined.

Overrides:

getTitleKey in class Link

Returns:

a key or null if undefined, in which case check "getTitle"

getTitleArgs

public List getTitleArgs()

Description copied from class: Link

Retrieves the arguments to use in the internationalised message identified by Link.getTitleKey()

Overrides:

getTitleArgs in class Link

Returns:

a list of arguments; null or an empty list if there are none.

getUrl

public String getUrl()

Description copied from class: Link

Get the destination URL for this link. It should be html escaped so it can be embedded directly into html without any XSS attacks.

Overrides:

getUrl in class Link

getWikiDestination

public String getWikiDestination()

Description copied from class: Link

Gets the destination portion of the Link.originalLinkText.

Overrides:

getWikiDestination in class Link

getWikiTitle

public String getWikiTitle()

Description copied from class: Link

Gets the optional title portion of the Link.originalLinkText. Returns null if no title was present in the original link text.

Overrides:

getWikiTitle in class Link

isAliasSpecified

public boolean isAliasSpecified()

Description copied from class: Link

Returns true if the link markup specifies an alias.

Overrides:

isAliasSpecified in class Link