Package com.commercetools.importapi.models.common

Interface AssetSource

public interface AssetSource

An AssetSource is a representation of an Asset in a specific format, for example, a video in a certain encoding or an image in a certain resolution.

Example to create an instance using the builder pattern 

     AssetSource assetSource = AssetSource.builder()
             .uri("{uri}")
             .build()

  • Method Details

    • getUri

      @NotNull @NotNull String getUri()
      Returns:
      uri

    • getKey

      String getKey()
      Returns:
      key

    • getDimensions

      @Valid @Valid AssetDimensions getDimensions()

      The width and height of the Asset Source.

      Returns:
      dimensions

    • getContentType

      String getContentType()
      Returns:
      contentType

    • setUri

      void setUri(String uri)
      set uri
      Parameters:
      uri - value to be set

    • setKey

      void setKey(String key)
      set key
      Parameters:
      key - value to be set

    • setDimensions

      void setDimensions(AssetDimensions dimensions)

      The width and height of the Asset Source.

      Parameters:
      dimensions - value to be set

    • setContentType

      void setContentType(String contentType)
      set contentType
      Parameters:
      contentType - value to be set

    • of

      static AssetSource of()
      factory method
      Returns:
      instance of AssetSource

    • of

      static AssetSource of(AssetSource template)
      factory method to create a shallow copy AssetSource
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      AssetSource copyDeep()

    • deepCopy

      @Nullable static AssetSource deepCopy(@Nullable AssetSource template)
      factory method to create a deep copy of AssetSource
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static AssetSourceBuilder builder()
      builder factory method for AssetSource
      Returns:
      builder

    • builder

      static AssetSourceBuilder builder(AssetSource template)
      create builder for AssetSource instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withAssetSource

      default <T> T withAssetSource(Function<AssetSource,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<AssetSource> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference