Package com.commercetools.importapi.models.orders

Class ParcelBuilder

java.lang.Object
com.commercetools.importapi.models.orders.ParcelBuilder
All Implemented Interfaces:
Builder<Parcel>
public class ParcelBuilder extends Object implements Builder<Parcel>
ParcelBuilder
Example to create an instance using the builder pattern 

     Parcel parcel = Parcel.builder()
             .id("{id}")
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()

  • Constructor Details

    • ParcelBuilder

      public ParcelBuilder()

  • Method Details

    • id

      public ParcelBuilder id(String id)

      Unique identifier of the Parcel.

      Parameters:
      id - value to be set
      Returns:
      Builder

    • createdAt

      public ParcelBuilder createdAt(ZonedDateTime createdAt)

      Date and time (UTC) the Parcel was created.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • measurements

      public ParcelBuilder measurements(Function<ParcelMeasurementsBuilder,ParcelMeasurementsBuilder> builder)

      Information about the dimensions of the Parcel.

      Parameters:
      builder - function to build the measurements value
      Returns:
      Builder

    • withMeasurements

      public ParcelBuilder withMeasurements(Function<ParcelMeasurementsBuilder,ParcelMeasurements> builder)

      Information about the dimensions of the Parcel.

      Parameters:
      builder - function to build the measurements value
      Returns:
      Builder

    • measurements

      public ParcelBuilder measurements(@Nullable ParcelMeasurements measurements)

      Information about the dimensions of the Parcel.

      Parameters:
      measurements - value to be set
      Returns:
      Builder

    • trackingData

      public ParcelBuilder trackingData(Function<TrackingDataBuilder,TrackingDataBuilder> builder)

      Shipment tracking information of the Parcel.

      Parameters:
      builder - function to build the trackingData value
      Returns:
      Builder

    • withTrackingData

      public ParcelBuilder withTrackingData(Function<TrackingDataBuilder,TrackingData> builder)

      Shipment tracking information of the Parcel.

      Parameters:
      builder - function to build the trackingData value
      Returns:
      Builder

    • trackingData

      public ParcelBuilder trackingData(@Nullable TrackingData trackingData)

      Shipment tracking information of the Parcel.

      Parameters:
      trackingData - value to be set
      Returns:
      Builder

    • items

      public ParcelBuilder items(@Nullable DeliveryItem... items)

      Line Items or Custom Line Items delivered in this Parcel.

      Parameters:
      items - value to be set
      Returns:
      Builder

    • items

      public ParcelBuilder items(@Nullable List<DeliveryItem> items)

      Line Items or Custom Line Items delivered in this Parcel.

      Parameters:
      items - value to be set
      Returns:
      Builder

    • plusItems

      public ParcelBuilder plusItems(@Nullable DeliveryItem... items)

      Line Items or Custom Line Items delivered in this Parcel.

      Parameters:
      items - value to be set
      Returns:
      Builder

    • plusItems

      public ParcelBuilder plusItems(Function<DeliveryItemBuilder,DeliveryItemBuilder> builder)

      Line Items or Custom Line Items delivered in this Parcel.

      Parameters:
      builder - function to build the items value
      Returns:
      Builder

    • withItems

      public ParcelBuilder withItems(Function<DeliveryItemBuilder,DeliveryItemBuilder> builder)

      Line Items or Custom Line Items delivered in this Parcel.

      Parameters:
      builder - function to build the items value
      Returns:
      Builder

    • addItems

      public ParcelBuilder addItems(Function<DeliveryItemBuilder,DeliveryItem> builder)

      Line Items or Custom Line Items delivered in this Parcel.

      Parameters:
      builder - function to build the items value
      Returns:
      Builder

    • setItems

      public ParcelBuilder setItems(Function<DeliveryItemBuilder,DeliveryItem> builder)

      Line Items or Custom Line Items delivered in this Parcel.

      Parameters:
      builder - function to build the items value
      Returns:
      Builder

    • custom

      public ParcelBuilder custom(Function<CustomBuilder,CustomBuilder> builder)

      Custom Fields of the Parcel.

      Parameters:
      builder - function to build the custom value
      Returns:
      Builder

    • withCustom

      public ParcelBuilder withCustom(Function<CustomBuilder,Custom> builder)

      Custom Fields of the Parcel.

      Parameters:
      builder - function to build the custom value
      Returns:
      Builder

    • custom

      public ParcelBuilder custom(@Nullable Custom custom)

      Custom Fields of the Parcel.

      Parameters:
      custom - value to be set
      Returns:
      Builder

    • getId

      public String getId()

      Unique identifier of the Parcel.

      Returns:
      id

    • getCreatedAt

      public ZonedDateTime getCreatedAt()

      Date and time (UTC) the Parcel was created.

      Returns:
      createdAt

    • getMeasurements

      @Nullable public ParcelMeasurements getMeasurements()

      Information about the dimensions of the Parcel.

      Returns:
      measurements

    • getTrackingData

      @Nullable public TrackingData getTrackingData()

      Shipment tracking information of the Parcel.

      Returns:
      trackingData

    • getItems

      @Nullable public List<DeliveryItem> getItems()

      Line Items or Custom Line Items delivered in this Parcel.

      Returns:
      items

    • getCustom

      @Nullable public Custom getCustom()

      Custom Fields of the Parcel.

      Returns:
      custom

    • build

      public Parcel build()
      builds Parcel with checking for non-null required values
      Specified by:
      build in interface Builder<Parcel>
      Returns:
      Parcel

    • buildUnchecked

      public Parcel buildUnchecked()
      builds Parcel without checking for non-null required values
      Returns:
      Parcel

    • of

      public static ParcelBuilder of()
      factory method for an instance of ParcelBuilder
      Returns:
      builder

    • of

      public static ParcelBuilder of(Parcel template)
      create builder for Parcel instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder