io.wcm.handler.link

Class Link

java.lang.Object

io.wcm.handler.link.Link

@ProviderType
public final class Link
extends Object

Holds information about a link processed and resolved by LinkHandler.

Constructor Summary

Constructors

Constructor and Description
Link(LinkType linkType, LinkRequest linkRequest)

Method Summary

Modifier and Type	Method and Description
io.wcm.handler.commons.dom.Anchor	getAnchor()
Map<String,String>	getAnchorAttributes()
LinkRequest	getLinkRequest()
LinkType	getLinkType()
String	getMarkup()
io.wcm.handler.media.Asset	getTargetAsset()
com.day.cq.wcm.api.Page	getTargetPage()
io.wcm.handler.media.Rendition	getTargetRendition()
String	getUrl()
boolean	isLinkReferenceInvalid()
boolean	isValid()
void	setAnchor(io.wcm.handler.commons.dom.Anchor anchor)
void	setLinkReferenceInvalid(boolean linkReferenceInvalid)
void	setLinkRequest(LinkRequest linkRequest)
void	setTargetAsset(io.wcm.handler.media.Asset targetAsset)
void	setTargetPage(com.day.cq.wcm.api.Page targetPage)
void	setTargetRendition(io.wcm.handler.media.Rendition targetRendition)
void	setUrl(String url)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Link

public Link(LinkType linkType,
            LinkRequest linkRequest)

Parameters:

linkType - Link type

linkRequest - Processed link reference

Method Detail

getLinkType

public LinkType getLinkType()

Returns:

Link type

getLinkRequest

public LinkRequest getLinkRequest()

Returns:

Link request

setLinkRequest

public void setLinkRequest(LinkRequest linkRequest)

Parameters:

linkRequest - Link request

isLinkReferenceInvalid

public boolean isLinkReferenceInvalid()

Returns:

true if a link reference was set, but the reference was invalid and could not be resolved

setLinkReferenceInvalid

public void setLinkReferenceInvalid(boolean linkReferenceInvalid)

Parameters:

linkReferenceInvalid - true if a link reference was set, but the reference was invalid and could not be resolved

getAnchor

public io.wcm.handler.commons.dom.Anchor getAnchor()

Returns:

Anchor element

getAnchorAttributes

public Map<String,String> getAnchorAttributes()

Returns:

Map with all attributes of the anchor element. Returns null if anchor element is null.

setAnchor

public void setAnchor(io.wcm.handler.commons.dom.Anchor anchor)

Parameters:

anchor - Anchor element

getMarkup

public String getMarkup()

Returns:

Link markup (only the opening anchor tag) or null if resolving was not successful.

getUrl

public String getUrl()

Returns:

Link URL

setUrl

public void setUrl(String url)

Parameters:

url - Link URL

getTargetPage

public com.day.cq.wcm.api.Page getTargetPage()

Returns:

Target page referenced by the link (applies only for internal links)

setTargetPage

public void setTargetPage(com.day.cq.wcm.api.Page targetPage)

Parameters:

targetPage - Target page referenced by the link (applies only for internal links)

getTargetAsset

public io.wcm.handler.media.Asset getTargetAsset()

Returns:

Target media item (applies only for media links)

setTargetAsset

public void setTargetAsset(io.wcm.handler.media.Asset targetAsset)

Parameters:

targetAsset - Target media item (applies only for media links)

getTargetRendition

public io.wcm.handler.media.Rendition getTargetRendition()

Returns:

Target media rendition (applies only for media links)

setTargetRendition

public void setTargetRendition(io.wcm.handler.media.Rendition targetRendition)

Parameters:

targetRendition - Target media rendition (applies only for media links)

isValid

public boolean isValid()

Returns:

true if link is valid and was resolved successfully

toString

public String toString()

Overrides:

toString in class Object