com.icfolson.aem.library.core.link.builders.factory

Class LinkBuilderFactory

java.lang.Object

com.icfolson.aem.library.core.link.builders.factory.LinkBuilderFactory

public final class LinkBuilderFactory
extends Object

Factory for acquiring LinkBuilder instances.

Method Summary

Modifier and Type	Method and Description
static LinkBuilder	forLink(Link link) Get a builder instance for an existing Link.
static LinkBuilder	forPage(com.day.cq.wcm.api.Page page) Get a builder instance for a page.
static LinkBuilder	forPage(com.day.cq.wcm.api.Page page, boolean mapped) Get a builder instance for a page.
static LinkBuilder	forPage(com.day.cq.wcm.api.Page page, boolean mapped, TitleType titleType) Get a builder instance for a page using the specified title type on the returned builder.
static LinkBuilder	forPage(com.day.cq.wcm.api.Page page, TitleType titleType) Get a builder instance for a page using the specified title type on the returned builder.
static LinkBuilder	forPath(String path) Get a builder instance for a path.
static LinkBuilder	forResource(org.apache.sling.api.resource.Resource resource) Get a builder instance for a resource.
static LinkBuilder	forResource(org.apache.sling.api.resource.Resource resource, boolean mapped) Get a builder instance for a resource using the mapped path on the returned builder.

Methods inherited from class java.lang.Object

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

Method Detail

forLink

public static LinkBuilder forLink(Link link)

Get a builder instance for an existing Link. The path, extension, title, and target are copied from the link argument.

Parameters:

link - existing link

Returns:

builder

forPage

public static LinkBuilder forPage(com.day.cq.wcm.api.Page page)

Get a builder instance for a page. If the page contains a redirect, the builder will contain the redirect target rather than the page path.

Parameters:

page - page

Returns:

builder containing the path of the given page

forPage

public static LinkBuilder forPage(com.day.cq.wcm.api.Page page,
                                  TitleType titleType)

Get a builder instance for a page using the specified title type on the returned builder.

Parameters:

page - page

titleType - type of page title to set on the builder

Returns:

builder containing the path and title of the given page

forPage

public static LinkBuilder forPage(com.day.cq.wcm.api.Page page,
                                  boolean mapped)

Get a builder instance for a page. If the page contains a redirect, the builder will contain the redirect target rather than the page path.

Parameters:

page - page

mapped - if true, link path will be mapped through resource resolver

Returns:

builder containing the mapped path of the given page

forPage

public static LinkBuilder forPage(com.day.cq.wcm.api.Page page,
                                  boolean mapped,
                                  TitleType titleType)

Get a builder instance for a page using the specified title type on the returned builder.

Parameters:

page - page

mapped - if true, link path will be mapped through resource resolver

titleType - type of page title to set on the builder

Returns:

builder containing the path and title of the given page

forPath

public static LinkBuilder forPath(String path)

Get a builder instance for a path.

Parameters:

path - content or external path

Returns:

builder containing the given path

forResource

public static LinkBuilder forResource(org.apache.sling.api.resource.Resource resource)

Get a builder instance for a resource.

Parameters:

resource - resource

Returns:

builder containing the path of the given resource

forResource

public static LinkBuilder forResource(org.apache.sling.api.resource.Resource resource,
                                      boolean mapped)

Get a builder instance for a resource using the mapped path on the returned builder.

Parameters:

resource - resource

mapped - if true, link path will be mapped through resource resolver

Returns:

builder containing the mapped path of the given resource