Package com.commercetools.history.models.common

Interface KeyReference

public interface KeyReference
KeyReference
Example to create an instance using the builder pattern 

     KeyReference keyReference = KeyReference.builder()
             .key("{key}")
             .typeId(ReferenceTypeId.ASSOCIATE_ROLE)
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()
      Returns:
      key

    • getTypeId

      @NotNull @NotNull ReferenceTypeId getTypeId()
      Returns:
      typeId

    • setKey

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

    • setTypeId

      void setTypeId(ReferenceTypeId typeId)
      set typeId
      Parameters:
      typeId - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static KeyReferenceBuilder builder()
      builder factory method for KeyReference
      Returns:
      builder

    • builder

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

    • withKeyReference

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