Package com.commercetools.importapi.models.customfields

Interface Custom

public interface Custom

The representation to be sent to the server when creating a resource with Custom Fields.

Example to create an instance using the builder pattern 

     Custom custom = Custom.builder()
             .type(typeBuilder -> typeBuilder)
             .build()

  • Method Details

    • getType

      @NotNull @Valid @NotNull @Valid TypeKeyReference getType()

      The Type that provides the field definitions for this object. If the referenced Type does not exist, the state of the ImportOperation will be set to unresolved until the referenced Type is created.

      Returns:
      type

    • getFields

      @Valid @Valid FieldContainer getFields()

      The Custom Fields of this object.

      Returns:
      fields

    • setType

      void setType(TypeKeyReference type)

      The Type that provides the field definitions for this object. If the referenced Type does not exist, the state of the ImportOperation will be set to unresolved until the referenced Type is created.

      Parameters:
      type - value to be set

    • setFields

      void setFields(FieldContainer fields)

      The Custom Fields of this object.

      Parameters:
      fields - value to be set

    • of

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

    • of

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

    • copyDeep

      Custom copyDeep()

    • deepCopy

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

    • builder

      static CustomBuilder builder()
      builder factory method for Custom
      Returns:
      builder

    • builder

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

    • withCustom

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