io.wcm.handler.link

Class LinkRequest

java.lang.Object

io.wcm.handler.link.LinkRequest

@ProviderType
public final class LinkRequest
extends Object

Holds all properties that are part of a link handling request.

Constructor Summary

Constructors

Constructor and Description
LinkRequest(org.apache.sling.api.resource.Resource resource, com.day.cq.wcm.api.Page page, LinkArgs linkArgs)

Method Summary

Modifier and Type	Method and Description
LinkArgs	getLinkArgs()
com.day.cq.wcm.api.Page	getPage()
org.apache.sling.api.resource.Resource	getResource()
org.apache.sling.api.resource.ValueMap	getResourceProperties()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkRequest

public LinkRequest(org.apache.sling.api.resource.Resource resource,
                   com.day.cq.wcm.api.Page page,
                   LinkArgs linkArgs)

Parameters:

resource - Resource containing properties that define the link target

page - Target content page

linkArgs - Link arguments

Method Detail

getResource

public org.apache.sling.api.resource.Resource getResource()

Returns:

Resource containing properties that define the link target

getPage

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

Returns:

Target content page

getLinkArgs

public LinkArgs getLinkArgs()

Returns:

Link arguments

getResourceProperties

public org.apache.sling.api.resource.ValueMap getResourceProperties()

Returns:

Properties from resource containing target link. The value map is a copy of the original map so it is safe to change the property values contained in the map.

toString

public String toString()

Overrides:

toString in class Object