Package 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	Description
LinkArgs()

Method Summary

Modifier and Type	Method	Description
LinkArgs	clone()	Custom clone-method for LinkArgs
@NotNull LinkArgs	dummyLink(boolean value)
@NotNull LinkArgs	dummyLinkUrl(@Nullable String value)
boolean	equals(Object obj)
@NotNull LinkArgs	extension(@Nullable String value)
@NotNull LinkArgs	fragment(@Nullable String value)
@Nullable String	getDummyLinkUrl()
@Nullable String	getExtension()
@Nullable String	getFragment()
@Nullable String[]	getLinkTargetUrlFallbackProperty()
@NotNull org.apache.sling.api.resource.ValueMap	getProperties()	Custom properties that my be used by application-specific markup builders or processors.
@Nullable String	getQueryString()
@Nullable String	getSelectors()
@Nullable String	getSuffix()
@Nullable io.wcm.handler.url.UrlMode	getUrlMode()
int	hashCode()
boolean	isDummyLink()
@NotNull LinkArgs	linkTargetUrlFallbackProperty(@NotNull String @Nullable ... propertyNames)	Defines a "fallback" property name that is used to load link target information from a single property instead of the link type + link type depending property name.
@NotNull LinkArgs	properties(@NotNull Map<String,Object> map)	Custom properties that my be used by application-specific markup builders or processors.
@NotNull LinkArgs	property(@NotNull String key, @Nullable Object value)	Custom properties that my be used by application-specific markup builders or processors.
@NotNull LinkArgs	queryString(@Nullable String value)
@NotNull LinkArgs	selectors(@Nullable String value)
@NotNull LinkArgs	suffix(@Nullable String value)
String	toString()
@NotNull LinkArgs	urlMode(@Nullable 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

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

Returns:

URL mode for externalizing the URL

urlMode

@NotNull
public @NotNull LinkArgs urlMode(@Nullable
                                 @Nullable 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

@NotNull
public @NotNull 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

@Nullable
public @Nullable String getDummyLinkUrl()

Returns:

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

dummyLinkUrl

@NotNull
public @NotNull LinkArgs dummyLinkUrl(@Nullable
                                      @Nullable String value)

Parameters:

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

Returns:

this

getSelectors

@Nullable
public @Nullable String getSelectors()

Returns:

Selector string

selectors

@NotNull
public @NotNull LinkArgs selectors(@Nullable
                                   @Nullable String value)

Parameters:

value - Selector string

Returns:

this

getExtension

@Nullable
public @Nullable String getExtension()

Returns:

File extension

extension

@NotNull
public @NotNull LinkArgs extension(@Nullable
                                   @Nullable String value)

Parameters:

value - File extension

Returns:

this

getSuffix

@Nullable
public @Nullable String getSuffix()

Returns:

Suffix string

suffix

@NotNull
public @NotNull LinkArgs suffix(@Nullable
                                @Nullable String value)

Parameters:

value - Suffix string

Returns:

this

getQueryString

@Nullable
public @Nullable String getQueryString()

Returns:

Query parameters string (properly url-encoded)

queryString

@NotNull
public @NotNull LinkArgs queryString(@Nullable
                                     @Nullable String value)

Parameters:

value - Query parameters string (properly url-encoded)

Returns:

this

getFragment

@Nullable
public @Nullable String getFragment()

Returns:

Fragment identifier

fragment

@NotNull
public @NotNull LinkArgs fragment(@Nullable
                                  @Nullable String value)

Parameters:

value - Fragment identifier

Returns:

this

properties

@NotNull
public @NotNull LinkArgs properties(@NotNull
                                    @NotNull 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

@NotNull
public @NotNull LinkArgs property(@NotNull
                                  @NotNull String key,
                                  @Nullable
                                  @Nullable 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

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

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

Returns:

Value map

linkTargetUrlFallbackProperty

@NotNull
public @NotNull LinkArgs linkTargetUrlFallbackProperty(@NotNull
                                                       @NotNull String @Nullable ... propertyNames)

Defines a "fallback" property name that is used to load link target information from a single property instead of the link type + link type depending property name. This property is used for migration from components that do not support Link Handler. It is only used for reading, and never written back to. When opened and saved in the link dialog, the property is removed and instead the dedicated properties are used.

Parameters:

propertyNames - Property name(s)

Returns:

this

getLinkTargetUrlFallbackProperty

@Nullable
public @Nullable String[] getLinkTargetUrlFallbackProperty()

Returns:

Property name(s)

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