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

Class ComponentDataBuilder

java.lang.Object

com.adobe.cq.wcm.core.components.models.datalayer.builder.GenericDataBuilder<ComponentDataBuilder,ComponentData>

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

public final class ComponentDataBuilder
extends GenericDataBuilder<ComponentDataBuilder,ComponentData>

Data builder for components that are not a specific type of component. I.e. for components that are not pages, containers, or image components. This builder will produce a valid ComponentData object. For more specific data builders please see:

• ImageComponentDataBuilder
• ContainerDataBuilder
• PageDataBuilder

Method Summary

Modifier and Type	Method	Description
@NotNull ComponentData	build()	Build the data.
ComponentDataBuilder	withDescription(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's description.
ComponentDataBuilder	withLastModifiedDate(@NotNull Supplier<Date> supplier)	Set the supplier that supplies the component's last modified date.
ComponentDataBuilder	withLinkUrl(@NotNull Supplier<String> supplier)	Sets the supplier that supplies the component's link URL.
ComponentDataBuilder	withParentId(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's parent ID.
ComponentDataBuilder	withText(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's text.
ComponentDataBuilder	withTitle(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's title.
ComponentDataBuilder	withType(@NotNull Supplier<String> supplier)	Set the supplier that supplies the component's type.

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

build

@NotNull
public @NotNull ComponentData build()

Description copied from class: GenericDataBuilder

Build the data.

Specified by:

build in class GenericDataBuilder<ComponentDataBuilder,ComponentData>

Returns:

The data object.

withType

@NotNull
public ComponentDataBuilder 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 ComponentDataBuilder 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 ComponentDataBuilder 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 ComponentDataBuilder 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 ComponentDataBuilder 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 ComponentDataBuilder 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 ComponentDataBuilder 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()