Package com.commercetools.history.models.change

Interface AddEnumValueChange

All Superinterfaces:
Change
public interface AddEnumValueChange extends Change

Change triggered by the Add EnumValue to FieldDefinition update action.

Example to create an instance using the builder pattern 

     AddEnumValueChange addEnumValueChange = AddEnumValueChange.builder()
             .change("{change}")
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .fieldName("{fieldName}")
             .build()

  • Field Details

    • ADD_ENUM_VALUE_CHANGE

      static final String ADD_ENUM_VALUE_CHANGE
      discriminator value for AddEnumValueChange
      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

    • getNextValue

      @NotNull @Valid @NotNull @Valid EnumValue getNextValue()

      Value after the change.

      Returns:
      nextValue

    • getFieldName

      @NotNull @NotNull String getFieldName()

      Name of the updated FieldDefinition.

      Returns:
      fieldName

    • setChange

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

    • setNextValue

      void setNextValue(EnumValue nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • setFieldName

      void setFieldName(String fieldName)

      Name of the updated FieldDefinition.

      Parameters:
      fieldName - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static AddEnumValueChangeBuilder builder()
      builder factory method for AddEnumValueChange
      Returns:
      builder

    • builder

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

    • withAddEnumValueChange

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