Package com.commercetools.api.models.subscription

Interface PlatformFormat

All Superinterfaces:
DeliveryFormat
All Known Subinterfaces:
DeliveryPlatformFormat
public interface PlatformFormat extends DeliveryFormat

The PlatformFormat uses constructs that are similar to the ones used in the REST API, for example, on the Messages Query HTTP API.

Example to create an instance using the builder pattern 

     PlatformFormat platformFormat = PlatformFormat.builder()
             .build()

  • Field Details

  • Method Details

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static PlatformFormatBuilder builder()
      builder factory method for PlatformFormat
      Returns:
      builder

    • builder

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

    • withPlatformFormat

      default <T> T withPlatformFormat(Function<PlatformFormat,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<PlatformFormat> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference