Package com.commercetools.api.models.type

Interface TypeChangeEnumValueOrderAction

All Superinterfaces:
ResourceUpdateAction<TypeUpdateAction>, TypeUpdateAction
public interface TypeChangeEnumValueOrderAction extends TypeUpdateAction

Changes the order of EnumValues in an EnumType FieldDefinition. This update action can be used to update an EnumType FieldDefinition and a SetType FieldDefinition of EnumType.

Example to create an instance using the builder pattern 

     TypeChangeEnumValueOrderAction typeChangeEnumValueOrderAction = TypeChangeEnumValueOrderAction.builder()
             .fieldName("{fieldName}")
             .plusKeys(keysBuilder -> keysBuilder)
             .build()

  • Field Details

    • CHANGE_ENUM_VALUE_ORDER

      static final String CHANGE_ENUM_VALUE_ORDER
      discriminator value for TypeChangeEnumValueOrderAction
      See Also:

  • Method Details

    • getFieldName

      @NotNull @NotNull String getFieldName()

      name of the FieldDefinition to update.

      Returns:
      fieldName

    • getKeys

      @NotNull @NotNull List<String> getKeys()

      Must match the set of keys of the EnumValues in the FieldDefinition (apart from their order).

      Returns:
      keys

    • setFieldName

      void setFieldName(String fieldName)

      name of the FieldDefinition to update.

      Parameters:
      fieldName - value to be set

    • setKeys

      void setKeys(String... keys)

      Must match the set of keys of the EnumValues in the FieldDefinition (apart from their order).

      Parameters:
      keys - values to be set

    • setKeys

      void setKeys(List<String> keys)

      Must match the set of keys of the EnumValues in the FieldDefinition (apart from their order).

      Parameters:
      keys - values to be set

    • of

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

    • of

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

    • copyDeep

      TypeChangeEnumValueOrderAction copyDeep()
      Specified by:
      copyDeep in interface TypeUpdateAction

    • deepCopy

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

    • builder

      static TypeChangeEnumValueOrderActionBuilder builder()
      builder factory method for TypeChangeEnumValueOrderAction
      Returns:
      builder

    • builder

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

    • withTypeChangeEnumValueOrderAction

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