Package com.adobe.cq.wcm.core.components.commons.link

Interface LinkBuilder

@ConsumerType
public interface LinkBuilder

Builds a link and uses the specified link properties.

Method Summary

Modifier and Type	Method	Description
@NotNull Link	build()	Returns the resolved link.
@NotNull LinkBuilder	withLinkAttribute(@NotNull java.lang.String name, @Nullable java.lang.String value)	Uses the specified HTML link attribute.
@NotNull LinkBuilder	withLinkTarget(@NotNull java.lang.String target)	Uses the specified HTML link target.
@NotNull LinkBuilder	withLinkUrlPropertyName(@NotNull java.lang.String name)	Uses the specified property name to read the link URL from.

Method Detail

withLinkUrlPropertyName

@NotNull
@NotNull LinkBuilder withLinkUrlPropertyName(@NotNull
                                             @NotNull java.lang.String name)

Uses the specified property name to read the link URL from.

Parameters:

name - The property name

Returns:

LinkBuilder

withLinkTarget

@NotNull
@NotNull LinkBuilder withLinkTarget(@NotNull
                                    @NotNull java.lang.String target)

Uses the specified HTML link target.

Parameters:

target - The link target

Returns:

LinkBuilder

withLinkAttribute

@NotNull
@NotNull LinkBuilder withLinkAttribute(@NotNull
                                       @NotNull java.lang.String name,
                                       @Nullable
                                       @Nullable java.lang.String value)

Uses the specified HTML link attribute.

Parameters:

name - The attribute name

value - The attribute value

Returns:

LinkBuilder

build

@NotNull
@NotNull Link build()

Returns the resolved link.

Returns:

Link