Package com.commercetools.api.models.type

Interface CustomFieldEnumValue

All Superinterfaces:
WithKey
public interface CustomFieldEnumValue extends WithKey

Defines an allowed value of a CustomFieldEnumType field.

Example to create an instance using the builder pattern 

     CustomFieldEnumValue customFieldEnumValue = CustomFieldEnumValue.builder()
             .key("{key}")
             .label("{label}")
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      Key of the value used as a programmatic identifier.

      Specified by:
      getKey in interface WithKey
      Returns:
      key

    • getLabel

      @NotNull @NotNull String getLabel()

      Descriptive label of the value.

      Returns:
      label

    • setKey

      void setKey(String key)

      Key of the value used as a programmatic identifier.

      Parameters:
      key - value to be set

    • setLabel

      void setLabel(String label)

      Descriptive label of the value.

      Parameters:
      label - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static CustomFieldEnumValueBuilder builder()
      builder factory method for CustomFieldEnumValue
      Returns:
      builder

    • builder

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

    • withCustomFieldEnumValue

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