Package com.commercetools.history.models.common

Interface Reference

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

     Reference reference = Reference.builder()
             .id("{id}")
             .typeId(ReferenceTypeId.ASSOCIATE_ROLE)
             .build()

  • Method Details

    • getId

      @NotNull @NotNull String getId()
      Returns:
      id

    • getTypeId

      @NotNull @NotNull ReferenceTypeId getTypeId()
      Returns:
      typeId

    • setId

      void setId(String id)
      set id
      Parameters:
      id - value to be set

    • setTypeId

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

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ReferenceBuilder builder()
      builder factory method for Reference
      Returns:
      builder

    • builder

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

    • withReference

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