Package com.commercetools.importapi.models.customfields

Interface EnumField

All Superinterfaces:
CustomField
public interface EnumField extends CustomField

A field with an enum value.

Example to create an instance using the builder pattern 

     EnumField enumField = EnumField.builder()
             .value("{value}")
             .build()

  • Field Details

  • Method Details

    • getValue

      @NotNull @NotNull String getValue()

      The key of the enum value. Must be a key of one of the CustomFieldEnumValues defined in the CustomFieldEnumType.

      Returns:
      value

    • setValue

      void setValue(String value)

      The key of the enum value. Must be a key of one of the CustomFieldEnumValues defined in the CustomFieldEnumType.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • copyDeep

      EnumField copyDeep()
      Specified by:
      copyDeep in interface CustomField

    • deepCopy

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

    • builder

      static EnumFieldBuilder builder()
      builder factory method for EnumField
      Returns:
      builder

    • builder

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

    • withEnumField

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