Package com.commercetools.api.models.variant_attributes

Interface VariantAttributesAttributeMetadata

public interface VariantAttributesAttributeMetadata

Metadata about a requested Attribute, derived from the ProductType.

Example to create an instance using the builder pattern 

     VariantAttributesAttributeMetadata variantAttributesAttributeMetadata = VariantAttributesAttributeMetadata.builder()
             .name("{name}")
             .label(labelBuilder -> labelBuilder)
             .type("{type}")
             .build()

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the Attribute as defined in the ProductType.

      Returns:
      name

    • getLabel

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

      Localized label of the Attribute as defined in the ProductType. Subject to locale projection if localeProjection is specified.

      Returns:
      label

    • getType

      @NotNull @NotNull String getType()

      Name of the AttributeType, for example boolean, text, ltext, enum, lenum, number, money, date, time, datetime, reference, set, or nested.

      Returns:
      type

    • setName

      void setName(String name)

      Name of the Attribute as defined in the ProductType.

      Parameters:
      name - value to be set

    • setLabel

      void setLabel(LocalizedString label)

      Localized label of the Attribute as defined in the ProductType. Subject to locale projection if localeProjection is specified.

      Parameters:
      label - value to be set

    • setType

      void setType(String type)

      Name of the AttributeType, for example boolean, text, ltext, enum, lenum, number, money, date, time, datetime, reference, set, or nested.

      Parameters:
      type - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantAttributesAttributeMetadata copyDeep()

    • deepCopy

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

    • builder

      static VariantAttributesAttributeMetadataBuilder builder()
      builder factory method for VariantAttributesAttributeMetadata
      Returns:
      builder

    • builder

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

    • withVariantAttributesAttributeMetadata

      default <T> T withVariantAttributesAttributeMetadata(Function<VariantAttributesAttributeMetadata,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<VariantAttributesAttributeMetadata> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference