Package com.commercetools.history.models.change

Interface SetPropertyChange

All Superinterfaces:
Change
public interface SetPropertyChange extends Change

Change triggered by the Update CustomObject request when an existing property is updated.

Example to create an instance using the builder pattern 

     SetPropertyChange setPropertyChange = SetPropertyChange.builder()
             .change("{change}")
             .path("{path}")
             .build()

  • Field Details

    • SET_PROPERTY_CHANGE

      static final String SET_PROPERTY_CHANGE
      discriminator value for SetPropertyChange
      See Also:

  • Method Details

    • getType

      @NotNull @NotNull String getType()
      Description copied from interface: Change

      Unique discriminator value to reliably deserialize the data type.

      Specified by:
      getType in interface Change
      Returns:
      type

    • getChange

      @NotNull @NotNull String getChange()
      Description copied from interface: Change

      Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

      Records can be filtered by this value using the changes query parameter.

      Specified by:
      getChange in interface Change
      Returns:
      change

    • getPreviousValue

      @NotNull @NotNull Object getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @NotNull Object getNextValue()

      Value after the change.

      Returns:
      nextValue

    • getPath

      @NotNull @NotNull String getPath()

      Path to the property that was updated.

      Returns:
      path

    • setChange

      void setChange(String change)
      set change
      Specified by:
      setChange in interface Change
      Parameters:
      change - value to be set

    • setPreviousValue

      void setPreviousValue(Object previousValue)

      Value before the change.

      Parameters:
      previousValue - value to be set

    • setNextValue

      void setNextValue(Object nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • setPath

      void setPath(String path)

      Path to the property that was updated.

      Parameters:
      path - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static SetPropertyChangeBuilder builder()
      builder factory method for SetPropertyChange
      Returns:
      builder

    • builder

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

    • withSetPropertyChange

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