io.wcm.handler.link

Interface LinkBuilder

@ProviderType
public interface LinkBuilder

Define link handling request using builder pattern.

Method Summary

Modifier and Type	Method and Description
LinkBuilder	args(LinkArgs linkArgs) Set link arguments
Link	build() Resolve link and return metadata object that contains the results.
io.wcm.handler.commons.dom.Anchor	buildAnchor() Resolve link and return directly the markup as DOM element generated by the link markup builder.
String	buildMarkup() Resolve link and return directly the markup generated by the link markup builder.
String	buildUrl() Resolve link and get URL.
LinkBuilder	dummyLink(boolean value)
LinkBuilder	dummyLinkUrl(String value)
LinkBuilder	extension(String extension) Set file extension
LinkBuilder	fragment(String fragment) Set fragment identifier
LinkBuilder	queryString(String queryString) Set query parameters string
LinkBuilder	selectors(String selectors) Set selectors
LinkBuilder	suffix(String suffix) Set suffix
LinkBuilder	urlMode(io.wcm.handler.url.UrlMode urlMode) Set URL mode for externalizing the URL

Method Detail

args

LinkBuilder args(LinkArgs linkArgs)

Set link arguments

Parameters:

linkArgs - Link arguments

Returns:

Link builder

selectors

LinkBuilder selectors(String selectors)

Set selectors

Parameters:

selectors - Selector string

Returns:

Link builder

extension

LinkBuilder extension(String extension)

Set file extension

Parameters:

extension - File extension

Returns:

Link builder

suffix

LinkBuilder suffix(String suffix)

Set suffix

Parameters:

suffix - Suffix string

Returns:

Link builder

queryString

LinkBuilder queryString(String queryString)

Set query parameters string

Parameters:

queryString - Query parameters string (properly url-encoded)

Returns:

Link builder

fragment

LinkBuilder fragment(String fragment)

Set fragment identifier

Parameters:

fragment - Fragment identifier

Returns:

Link builder

urlMode

LinkBuilder urlMode(io.wcm.handler.url.UrlMode urlMode)

Set URL mode for externalizing the URL

Parameters:

urlMode - URL mode. If null, default URL mode is used.

Returns:

Link builder

dummyLink

LinkBuilder dummyLink(boolean value)

Parameters:

value - If set to true, link handler returns a dummy link in edit mode when link is invalid.

Returns:

this

dummyLinkUrl

LinkBuilder dummyLinkUrl(String value)

Parameters:

value - Custom dummy link url. If null default dummy url is used.

Returns:

this

build

Link build()

Resolve link and return metadata object that contains the results.

Returns:

Link metadata object. Never null, if the resolving failed the isValid() method returns false.

buildMarkup

String buildMarkup()

Resolve link and return directly the markup generated by the link markup builder.

Returns:

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

buildAnchor

io.wcm.handler.commons.dom.Anchor buildAnchor()

Resolve link and return directly the markup as DOM element generated by the link markup builder.

Returns:

Link markup or null if resolving was not successful.

buildUrl

String buildUrl()

Resolve link and get URL.

Returns:

Link URL or null if resolving was not successful.