com.atlassian.renderer.links

Class UnpermittedLink

java.lang.Object

com.atlassian.renderer.links.Link

com.atlassian.renderer.links.UnpermittedLink

public class UnpermittedLink
extends Link

A link to a resource that exists, but that the current user is not permitted to access. Generally, these should be treated identically to unresolved links (so users don't get an idea about what might exist but they can't see), but internal link-tracking systems will obviously need to know the difference.

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
UnpermittedLink(Link wrappedLink)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getLinkBody() Get the contents that are being marked up by the link
String	getTitle() Get the link title text
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.
Link	getWrappedLink()
int	hashCode()
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

getIconName, getLinkAttributes, getOriginalLinkText, getTitleArgs, getTitleKey, getUnpermittedLinkBody

Methods inherited from class java.lang.Object

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

Constructor Detail

UnpermittedLink

public UnpermittedLink(Link wrappedLink)

Method Detail

getWrappedLink

public Link getWrappedLink()

getLinkBody

public String getLinkBody()

Description copied from class: Link

Get the contents that are being marked up by the link

Overrides:

getLinkBody in class Link

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

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

equals

public boolean equals(Object o)

Overrides:

equals in class Link

hashCode

public int hashCode()

Overrides:

hashCode in class Link