Class DeliveryParcelBuilder
- All Implemented Interfaces:
Builder<DeliveryParcel>
Example to create an instance using the builder pattern
DeliveryParcel deliveryParcel = DeliveryParcel.builder()
.deliveryId("{deliveryId}")
.build()
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddItems
(Function<DeliveryItemBuilder, DeliveryItem> builder) Line Items or Custom Line Items delivered in this Parcel.build()
builds DeliveryParcel with checking for non-null required valuesbuilds DeliveryParcel without checking for non-null required valuesdeliveryId
(String deliveryId) Unique identifier of the Delivery.Unique identifier of the Delivery.getItems()
Line Items or Custom Line Items delivered in this Parcel.Information about the dimensions of the Parcel.Shipment tracking information of the Parcel.items
(DeliveryItem... items) Line Items or Custom Line Items delivered in this Parcel.items
(List<DeliveryItem> items) Line Items or Custom Line Items delivered in this Parcel.measurements
(ParcelMeasurements measurements) Information about the dimensions of the Parcel.Information about the dimensions of the Parcel.static DeliveryParcelBuilder
of()
factory method for an instance of DeliveryParcelBuilderstatic DeliveryParcelBuilder
of
(DeliveryParcel template) create builder for DeliveryParcel instanceplusItems
(DeliveryItem... items) Line Items or Custom Line Items delivered in this Parcel.Line Items or Custom Line Items delivered in this Parcel.setItems
(Function<DeliveryItemBuilder, DeliveryItem> builder) Line Items or Custom Line Items delivered in this Parcel.trackingData
(TrackingData trackingData) Shipment tracking information of the Parcel.Shipment tracking information of the Parcel.Line Items or Custom Line Items delivered in this Parcel.Information about the dimensions of the Parcel.Shipment tracking information of the Parcel.
-
Constructor Details
-
DeliveryParcelBuilder
public DeliveryParcelBuilder()
-
-
Method Details
-
deliveryId
Unique identifier of the Delivery.
- Parameters:
deliveryId
- value to be set- Returns:
- Builder
-
measurements
public DeliveryParcelBuilder measurements(Function<ParcelMeasurementsBuilder, ParcelMeasurementsBuilder> builder) Information about the dimensions of the Parcel.
- Parameters:
builder
- function to build the measurements value- Returns:
- Builder
-
withMeasurements
public DeliveryParcelBuilder withMeasurements(Function<ParcelMeasurementsBuilder, ParcelMeasurements> builder) Information about the dimensions of the Parcel.
- Parameters:
builder
- function to build the measurements value- Returns:
- Builder
-
measurements
Information about the dimensions of the Parcel.
- Parameters:
measurements
- value to be set- Returns:
- Builder
-
trackingData
public DeliveryParcelBuilder trackingData(Function<TrackingDataBuilder, TrackingDataBuilder> builder) Shipment tracking information of the Parcel.
- Parameters:
builder
- function to build the trackingData value- Returns:
- Builder
-
withTrackingData
Shipment tracking information of the Parcel.
- Parameters:
builder
- function to build the trackingData value- Returns:
- Builder
-
trackingData
Shipment tracking information of the Parcel.
- Parameters:
trackingData
- value to be set- Returns:
- Builder
-
items
Line Items or Custom Line Items delivered in this Parcel.
- Parameters:
items
- value to be set- Returns:
- Builder
-
items
Line Items or Custom Line Items delivered in this Parcel.
- Parameters:
items
- value to be set- Returns:
- Builder
-
plusItems
Line Items or Custom Line Items delivered in this Parcel.
- Parameters:
items
- value to be set- Returns:
- Builder
-
plusItems
Line Items or Custom Line Items delivered in this Parcel.
- Parameters:
builder
- function to build the items value- Returns:
- Builder
-
withItems
Line Items or Custom Line Items delivered in this Parcel.
- Parameters:
builder
- function to build the items value- Returns:
- Builder
-
addItems
Line Items or Custom Line Items delivered in this Parcel.
- Parameters:
builder
- function to build the items value- Returns:
- Builder
-
setItems
Line Items or Custom Line Items delivered in this Parcel.
- Parameters:
builder
- function to build the items value- Returns:
- Builder
-
getDeliveryId
Unique identifier of the Delivery.
- Returns:
- deliveryId
-
getMeasurements
Information about the dimensions of the Parcel.
- Returns:
- measurements
-
getTrackingData
Shipment tracking information of the Parcel.
- Returns:
- trackingData
-
getItems
Line Items or Custom Line Items delivered in this Parcel.
- Returns:
- items
-
build
builds DeliveryParcel with checking for non-null required values- Specified by:
build
in interfaceBuilder<DeliveryParcel>
- Returns:
- DeliveryParcel
-
buildUnchecked
builds DeliveryParcel without checking for non-null required values- Returns:
- DeliveryParcel
-
of
factory method for an instance of DeliveryParcelBuilder- Returns:
- builder
-
of
create builder for DeliveryParcel instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-