Package com.commercetools.history.models.common

Interface ResourceIdentifier

All Known Subinterfaces:
BusinessUnitResourceIdentifier, ZoneResourceIdentifier
public interface ResourceIdentifier
ResourceIdentifier
Example to create an instance using the builder pattern 

     ResourceIdentifier resourceIdentifier = ResourceIdentifier.builder()
             .typeId(ReferenceTypeId.APPROVAL_FLOW)
             .build()

  • Method Details

    • getId

      String getId()
      Returns:
      id

    • getKey

      String getKey()
      Returns:
      key

    • getTypeId

      @NotNull @NotNull ReferenceTypeId getTypeId()

      Type of resource the value should reference. Supported resource type identifiers are:

      Returns:
      typeId

    • setId

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

    • setKey

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

    • setTypeId

      void setTypeId(ReferenceTypeId typeId)

      Type of resource the value should reference. Supported resource type identifiers are:

      Parameters:
      typeId - value to be set

    • of

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

    • of

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

    • copyDeep

      ResourceIdentifier copyDeep()

    • deepCopy

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

    • builder

      static ResourceIdentifierBuilder builder()
      builder factory method for ResourceIdentifier
      Returns:
      builder

    • builder

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

    • withResourceIdentifier

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