Package io.wcm.handler.link
Class LinkRequest
- java.lang.Object
-
- io.wcm.handler.link.LinkRequest
-
@ProviderType public final class LinkRequest extends java.lang.Object
Holds all properties that are part of a link handling request.
-
-
Constructor Summary
Constructors Constructor Description LinkRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable com.day.cq.wcm.api.Page page, @Nullable LinkArgs linkArgs)
LinkRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable com.day.cq.wcm.api.Page page, @Nullable java.lang.String reference, @Nullable LinkArgs linkArgs)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NotNull LinkArgs
getLinkArgs()
@Nullable com.day.cq.wcm.api.Page
getPage()
@Nullable java.lang.String
getReference()
@Nullable org.apache.sling.api.resource.Resource
getResource()
@NotNull org.apache.sling.api.resource.ValueMap
getResourceProperties()
java.lang.String
toString()
-
-
-
Constructor Detail
-
LinkRequest
public LinkRequest(@Nullable @Nullable org.apache.sling.api.resource.Resource resource, @Nullable @Nullable com.day.cq.wcm.api.Page page, @Nullable @Nullable LinkArgs linkArgs)
- Parameters:
resource
- Resource containing properties that define the link targetpage
- Target content pagelinkArgs
- Link arguments
-
LinkRequest
public LinkRequest(@Nullable @Nullable org.apache.sling.api.resource.Resource resource, @Nullable @Nullable com.day.cq.wcm.api.Page page, @Nullable @Nullable java.lang.String reference, @Nullable @Nullable LinkArgs linkArgs)
- Parameters:
resource
- Resource containing properties that define the link targetpage
- Target content pagereference
- Link reference (internal or external).linkArgs
- Link arguments
-
-
Method Detail
-
getResource
@Nullable public @Nullable org.apache.sling.api.resource.Resource getResource()
- Returns:
- Resource containing properties that define the link target
-
getPage
@Nullable public @Nullable com.day.cq.wcm.api.Page getPage()
- Returns:
- Target content page
-
getReference
@Nullable public @Nullable java.lang.String getReference()
- Returns:
- Link reference (internal or external).
-
getLinkArgs
@NotNull public @NotNull LinkArgs getLinkArgs()
- Returns:
- Link arguments
-
getResourceProperties
@NotNull public @NotNull 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 java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-