io.wcm.handler.link

Class LinkArgs

java.lang.Object

io.wcm.handler.link.LinkArgs

All Implemented Interfaces:

Cloneable

@ProviderType
public final class LinkArgs
extends Object
implements Cloneable

Holds parameters to influence the link resolving process.

Constructor Summary

Constructors

Constructor and Description
LinkArgs()

Method Summary

Modifier and Type	Method and Description
LinkArgs	clone() Custom clone-method for LinkArgs
LinkArgs	dummyLink(boolean value)
LinkArgs	dummyLinkUrl(String value)
boolean	equals(Object obj)
LinkArgs	extension(String value)
LinkArgs	fragment(String value)
String	getDummyLinkUrl()
String	getExtension()
String	getFragment()
org.apache.sling.api.resource.ValueMap	getProperties() Custom properties that my be used by application-specific markup builders or processors.
String	getQueryString()
String	getSelectors()
String	getSuffix()
io.wcm.handler.url.UrlMode	getUrlMode()
int	hashCode()
boolean	isDummyLink()
LinkArgs	properties(Map<String,Object> map) Custom properties that my be used by application-specific markup builders or processors.
LinkArgs	property(String key, Object value) Custom properties that my be used by application-specific markup builders or processors.
LinkArgs	queryString(String value)
LinkArgs	selectors(String value)
LinkArgs	suffix(String value)
String	toString()
LinkArgs	urlMode(io.wcm.handler.url.UrlMode value)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LinkArgs

public LinkArgs()

Method Detail

getUrlMode

public io.wcm.handler.url.UrlMode getUrlMode()

Returns:

URL mode for externalizing the URL

urlMode

public LinkArgs urlMode(io.wcm.handler.url.UrlMode value)

Parameters:

value - URL mode for externalizing the URL

Returns:

this

isDummyLink

public boolean isDummyLink()

Returns:

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

dummyLink

public LinkArgs dummyLink(boolean value)

Parameters:

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

Returns:

this

getDummyLinkUrl

public String getDummyLinkUrl()

Returns:

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

dummyLinkUrl

public LinkArgs dummyLinkUrl(String value)

Parameters:

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

Returns:

this

getSelectors

public String getSelectors()

Returns:

Selector string

selectors

public LinkArgs selectors(String value)

Parameters:

value - Selector string

Returns:

this

getExtension

public String getExtension()

Returns:

File extension

extension

public LinkArgs extension(String value)

Parameters:

value - File extension

Returns:

this

getSuffix

public String getSuffix()

Returns:

Suffix string

suffix

public LinkArgs suffix(String value)

Parameters:

value - Suffix string

Returns:

this

getQueryString

public String getQueryString()

Returns:

Query parameters string (properly url-encoded)

queryString

public LinkArgs queryString(String value)

Parameters:

value - Query parameters string (properly url-encoded)

Returns:

this

getFragment

public String getFragment()

Returns:

Fragment identifier

fragment

public LinkArgs fragment(String value)

Parameters:

value - Fragment identifier

Returns:

this

properties

public LinkArgs properties(Map<String,Object> map)

Custom properties that my be used by application-specific markup builders or processors.

Parameters:

map - Property map. Is merged with properties already set.

Returns:

this

property

public LinkArgs property(String key,
                         Object value)

Custom properties that my be used by application-specific markup builders or processors.

Parameters:

key - Property key

value - Property value

Returns:

this

getProperties

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

Custom properties that my be used by application-specific markup builders or processors.

Returns:

Value map

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public LinkArgs clone()

Custom clone-method for LinkArgs

Overrides:

clone in class Object

Returns:

the cloned LinkArgs