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

Class PageDataBuilder

  • public final class PageDataBuilder
extends GenericDataBuilder<T,​K>
    Data layer builder for pages. This builder will produce a valid PageData object.

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • withTags

        @NotNull
public @NotNull PageDataBuilder withTags​(@NotNull
                                         @NotNull java.util.function.Supplier<java.lang.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 java.util.function.Supplier<java.lang.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 java.util.function.Supplier<java.lang.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 java.util.function.Supplier<java.lang.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()

      • withType

        @NotNull
public T withType​(@NotNull
                  @NotNull java.util.function.Supplier<java.lang.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 java.util.function.Supplier<java.util.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 java.util.function.Supplier<java.lang.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 java.util.function.Supplier<java.lang.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 java.util.function.Supplier<java.lang.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 java.util.function.Supplier<java.lang.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 java.util.function.Supplier<java.lang.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()