Package com.adobe.cq.wcm.core.components.models.datalayer.builder

Class PageDataBuilder

java.lang.Object

com.adobe.cq.wcm.core.components.models.datalayer.builder.GenericDataBuilder<PageDataBuilder,PageData>

com.adobe.cq.wcm.core.components.models.datalayer.builder.PageDataBuilder

public final class PageDataBuilder
extends GenericDataBuilder<PageDataBuilder,PageData>

Data layer builder for pages. This builder will produce a valid PageData object.

Method Summary

Modifier and Type	Method	Description
@NotNull PageData	build()	Build the data.
PageDataBuilder	withDescription(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's description.
@NotNull PageDataBuilder	withLanguage(@NotNull Supplier<String> supplier)	Set the supplier that supplies the page's language data.
PageDataBuilder	withLastModifiedDate(@NotNull Supplier<Date> supplier)	Set the supplier that supplies the component's last modified date.
PageDataBuilder	withLinkUrl(@NotNull Supplier<String> supplier)	Sets the supplier that supplies the component's link URL.
PageDataBuilder	withParentId(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's parent ID.
@NotNull PageDataBuilder	withTags(@NotNull Supplier<String[]> supplier)	Set the supplier that supplies the page's tags data.
@NotNull PageDataBuilder	withTemplatePath(@NotNull Supplier<String> supplier)	Set the supplier that supplies the page's template path data.
PageDataBuilder	withText(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's text.
PageDataBuilder	withTitle(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's title.
PageDataBuilder	withType(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's type.
@NotNull PageDataBuilder	withUrl(@NotNull Supplier<String> supplier)	Set the supplier that supplies the page's URL data.

Methods inherited from class com.adobe.cq.wcm.core.components.models.datalayer.builder.GenericDataBuilder

withId

Methods inherited from class java.lang.Object

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

Method Details

withTags

@NotNull
public @NotNull PageDataBuilder withTags(@NotNull
 @NotNull Supplier<String[]> supplier)

Set the supplier that supplies the page's tags data.

Parameters:

supplier - The tags data value supplier.

Returns:

A new PageDataBuilder.

See Also:

• PageData.getTags()

withUrl

@NotNull
public @NotNull PageDataBuilder withUrl(@NotNull
 @NotNull Supplier<String> supplier)

Set the supplier that supplies the page's URL data.

Parameters:

supplier - The URL data value supplier.

Returns:

A new PageDataBuilder.

See Also:

• PageData.getUrl()

withTemplatePath

@NotNull
public @NotNull PageDataBuilder withTemplatePath(@NotNull
 @NotNull Supplier<String> supplier)

Set the supplier that supplies the page's template path data.

Parameters:

supplier - The template path data value supplier.

Returns:

A new PageDataBuilder.

See Also:

• PageData.getTemplatePath()

withLanguage

@NotNull
public @NotNull PageDataBuilder withLanguage(@NotNull
 @NotNull Supplier<String> supplier)

Set the supplier that supplies the page's language data.

Parameters:

supplier - The language data value supplier.

Returns:

A new PageDataBuilder.

See Also:

• PageData.getLanguage()

build

@NotNull
public @NotNull PageData build()

Description copied from class: GenericDataBuilder

Build the data.

Specified by:

build in class GenericDataBuilder<PageDataBuilder,PageData>

Returns:

The data object.

withType

@NotNull
public PageDataBuilder withType(@NotNull
 @NotNull Supplier<String> supplier)

Set the supplier that supplies the component's type.

Parameters:

supplier - The type value supplier.

Returns:

A new data builder.

See Also:

• ComponentData.getType()

withLastModifiedDate

@NotNull
public PageDataBuilder withLastModifiedDate(@NotNull
 @NotNull Supplier<Date> supplier)

Set the supplier that supplies the component's last modified date.

Parameters:

supplier - The last modified date value supplier.

Returns:

A new data builder.

See Also:

• ComponentData.getLastModifiedDate()

withParentId

@NotNull
public PageDataBuilder withParentId(@NotNull
 @NotNull Supplier<String> supplier)

Set the supplier that supplies the component's parent ID.

Parameters:

supplier - The parent ID value supplier.

Returns:

A new data builder.

See Also:

• ComponentData.getParentId()

withTitle

@NotNull
public PageDataBuilder withTitle(@NotNull
 @NotNull Supplier<String> supplier)

Set the supplier that supplies the component's title.

Parameters:

supplier - The title value supplier.

Returns:

A new data builder.

See Also:

• ComponentData.getTitle()

withDescription

@NotNull
public PageDataBuilder withDescription(@NotNull
 @NotNull Supplier<String> supplier)

Set the supplier that supplies the component's description.

Parameters:

supplier - The description value supplier.

Returns:

A new data builder.

See Also:

• ComponentData.getDescription()

withText

@NotNull
public PageDataBuilder withText(@NotNull
 @NotNull Supplier<String> supplier)

Set the supplier that supplies the component's text.

Parameters:

supplier - The text value supplier.

Returns:

A new data builder.

See Also:

• ComponentData.getText()

withLinkUrl

@NotNull
public PageDataBuilder withLinkUrl(@NotNull
 @NotNull Supplier<String> supplier)

Sets the supplier that supplies the component's link URL.

Parameters:

supplier - The link URL value supplier.

Returns:

A new data builder.

See Also:

• ComponentData.getLinkUrl()