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

Class ContainerDataBuilder

java.lang.Object

com.adobe.cq.wcm.core.components.models.datalayer.builder.GenericDataBuilder<T,K>

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

public final class ContainerDataBuilder
extends GenericDataBuilder<T,K>

Data builder for container components. This builder will produce a valid ContainerData object.

Method Summary

Modifier and Type	Method and Description
@NotNull ContainerData	build() Build the data.
T	withDescription(@NotNull Supplier<String> supplier) Set the supplier that supplies the component's description.
T	withLastModifiedDate(@NotNull Supplier<Date> supplier) Set the supplier that supplies the component's last modified date.
T	withLinkUrl(@NotNull Supplier<String> supplier) Sets the supplier that supplies the component's link URL.
T	withParentId(@NotNull Supplier<String> supplier) Set the supplier that supplies the component's parent ID.
@NotNull ContainerDataBuilder	withShownItems(@NotNull Supplier<String[]> supplier) Set the supplier that supplies the array of shown items.
T	withText(@NotNull Supplier<String> supplier) Set the supplier that supplies the component's text.
T	withTitle(@NotNull Supplier<String> supplier) Set the supplier that supplies the component's title.
T	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

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

Method Detail

withShownItems

@NotNull
public @NotNull ContainerDataBuilder withShownItems(@NotNull
                                                             @NotNull Supplier<String[]> supplier)

Set the supplier that supplies the array of shown items.

Parameters:

supplier - The shown items value supplier.

Returns:

A new ContainerDataBuilder.

See Also:

ContainerData.getShownItems()

build

@NotNull
public @NotNull ContainerData build()

Description copied from class: GenericDataBuilder

Build the data.

Specified by:

build in class GenericDataBuilder<ContainerDataBuilder,ContainerData>

Returns:

The data object.

withType

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