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

Interface DataLayerSupplier

  • public interface DataLayerSupplier
    Data layer field value supplier. A supplier for every possible Data Layer field is provided via this interface.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static DataLayerSupplier EMPTY_SUPPLIER
      An empty DataLayerSupplier which has null values for all field value suppliers.

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default @NotNull java.util.Optional<java.util.function.Supplier<AssetData>> getAssetData()
      Get the asset data field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<ContentFragmentData.ElementData[]>> getContentFragmentElements()
      Get the content fragment elements field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getDescription()
      Get the description field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.util.Map<java.lang.String,​java.lang.Object>>> getEmbeddableDetails()
      Get the embeddable details value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getFormat()
      Get the format field value supplier.
      default @NotNull java.util.function.Supplier<@NotNull java.lang.String> getId()
      Get the ID field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getLanguage()
      Get the language field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.util.Date>> getLastModifiedDate()
      Get the last modified date field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getLinkUrl()
      Get the link URL field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getParentId()
      Get the parent ID field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String[]>> getShownItems()
      Get the shown items field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.util.Map<java.lang.String,​java.lang.Object>>> getSmartTags()
      Get the smart tags field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String[]>> getTags()
      Get the tags field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getTemplatePath()
      Get the template path field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getText()
      Get the text field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getTitle()
      Get the title field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getType()
      Get the type field value supplier.
      default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getUrl()
      Get the URL field value supplier.

    • Field Detail

      • EMPTY_SUPPLIER

        static final DataLayerSupplier EMPTY_SUPPLIER
        An empty DataLayerSupplier which has null values for all field value suppliers.

    • Method Detail

      • getId

        @NotNull
default @NotNull java.util.function.Supplier<@NotNull java.lang.String> getId()
        Get the ID field value supplier.
        Returns:
        The ID field value supplier, or empty if not set.

      • getType

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getType()
        Get the type field value supplier.
        Returns:
        The type field value supplier, or empty if not set.

      • getLastModifiedDate

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.util.Date>> getLastModifiedDate()
        Get the last modified date field value supplier.
        Returns:
        The last modified data field value supplier, or empty if not set.

      • getParentId

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getParentId()
        Get the parent ID field value supplier.
        Returns:
        The parent ID field value supplier, or empty if not set.

      • getTitle

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getTitle()
        Get the title field value supplier.
        Returns:
        The title field value supplier, or empty if not set.

      • getDescription

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getDescription()
        Get the description field value supplier.
        Returns:
        The description field value supplier, or empty if not set.

      • getText

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getText()
        Get the text field value supplier.
        Returns:
        The text field value supplier, or empty if not set.

      • getLinkUrl

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getLinkUrl()
        Get the link URL field value supplier.
        Returns:
        The link URL field value supplier, or empty if not set.

      • getShownItems

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String[]>> getShownItems()
        Get the shown items field value supplier.
        Returns:
        The shown items field value supplier, or empty if not set.

      • getUrl

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getUrl()
        Get the URL field value supplier.
        Returns:
        The URL field value supplier, or empty if not set.

      • getFormat

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getFormat()
        Get the format field value supplier.
        Returns:
        The format field value supplier, or empty if not set.

      • getTags

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String[]>> getTags()
        Get the tags field value supplier.
        Returns:
        The tags field value supplier, or empty if not set.

      • getSmartTags

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.util.Map<java.lang.String,​java.lang.Object>>> getSmartTags()
        Get the smart tags field value supplier.
        Returns:
        The smart tags field value supplier, or empty if not set.

      • getEmbeddableDetails

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.util.Map<java.lang.String,​java.lang.Object>>> getEmbeddableDetails()
        Get the embeddable details value supplier.
        Returns:
        The embeddable details value supplier, or empty if not set.

      • getAssetData

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<AssetData>> getAssetData()
        Get the asset data field value supplier.
        Returns:
        The asset data field value supplier, or empty if not set.

      • getTemplatePath

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getTemplatePath()
        Get the template path field value supplier.
        Returns:
        The template path field value supplier, or empty if not set.

      • getLanguage

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<java.lang.String>> getLanguage()
        Get the language field value supplier.
        Returns:
        The language field value supplier, or empty if not set.

      • getContentFragmentElements

        @NotNull
default @NotNull java.util.Optional<java.util.function.Supplier<ContentFragmentData.ElementData[]>> getContentFragmentElements()
        Get the content fragment elements field value supplier.
        Returns:
        The content fragment elements field value supplier, or empty if not set.