Package com.commercetools.history.models.common

Interface AttributeLocalizedEnumValue

public interface AttributeLocalizedEnumValue

A localized enum value must be unique within the enum, else a DuplicateEnumValues error is returned.

Example to create an instance using the builder pattern 

     AttributeLocalizedEnumValue attributeLocalizedEnumValue = AttributeLocalizedEnumValue.builder()
             .key("{key}")
             .label(labelBuilder -> labelBuilder)
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      Key of the value used as a programmatic identifier, for example in facets & filters.

      Returns:
      key

    • getLabel

      @NotNull @Valid @NotNull @Valid LocalizedString getLabel()

      Descriptive, localized label of the value.

      Returns:
      label

    • setKey

      void setKey(String key)

      Key of the value used as a programmatic identifier, for example in facets & filters.

      Parameters:
      key - value to be set

    • setLabel

      void setLabel(LocalizedString label)

      Descriptive, localized label of the value.

      Parameters:
      label - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static AttributeLocalizedEnumValueBuilder builder()
      builder factory method for AttributeLocalizedEnumValue
      Returns:
      builder

    • builder

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

    • withAttributeLocalizedEnumValue

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