Package com.commercetools.importapi.models.common

Interface TypeKeyReference

All Superinterfaces:
KeyReference
public interface TypeKeyReference extends KeyReference

Used by the Import API to identify a Type.

Example to create an instance using the builder pattern 

     TypeKeyReference typeKeyReference = TypeKeyReference.builder()
             .key("{key}")
             .build()

  • Field Details

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the referenced Type.

      Specified by:
      getKey in interface KeyReference
      Returns:
      key

    • setKey

      void setKey(String key)

      User-defined unique identifier of the referenced Type.

      Specified by:
      setKey in interface KeyReference
      Parameters:
      key - value to be set

    • of

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

    • of

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

    • copyDeep

      TypeKeyReference copyDeep()
      Specified by:
      copyDeep in interface KeyReference

    • deepCopy

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

    • builder

      static TypeKeyReferenceBuilder builder()
      builder factory method for TypeKeyReference
      Returns:
      builder

    • builder

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

    • withTypeKeyReference

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