Package com.commercetools.api.models.message

Interface ContainerAndKey

public interface ContainerAndKey

ContainerAndKey is specific to Custom Objects. Custom Objects are grouped into containers, which can be used like namespaces. Within a given container, a user-defined key can be used to uniquely identify resources.

Example to create an instance using the builder pattern 

     ContainerAndKey containerAndKey = ContainerAndKey.builder()
             .key("{key}")
             .container("{container}")
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined identifier that is unique within the given container.

      Returns:
      key

    • getContainer

      @NotNull @NotNull String getContainer()

      Namespace to group Custom Objects.

      Returns:
      container

    • setKey

      void setKey(String key)

      User-defined identifier that is unique within the given container.

      Parameters:
      key - value to be set

    • setContainer

      void setContainer(String container)

      Namespace to group Custom Objects.

      Parameters:
      container - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ContainerAndKeyBuilder builder()
      builder factory method for ContainerAndKey
      Returns:
      builder

    • builder

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

    • withContainerAndKey

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