Package com.commercetools.api.models.order

Class ParcelDraftBuilder

java.lang.Object

com.commercetools.api.models.order.ParcelDraftBuilder

All Implemented Interfaces:

Builder<ParcelDraft>

public class ParcelDraftBuilder
extends Object
implements Builder<ParcelDraft>

ParcelDraftBuilder Example to create an instance using the builder pattern

     ParcelDraft parcelDraft = ParcelDraft.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ParcelDraftBuilder()

Method Summary

Modifier and Type	Method	Description
ParcelDraftBuilder	addItems(Function<DeliveryItemBuilder,DeliveryItem> builder)	Line Items or Custom Line Items delivered in this Parcel.
ParcelDraft	build()	builds ParcelDraft with checking for non-null required values
ParcelDraft	buildUnchecked()	builds ParcelDraft without checking for non-null required values
ParcelDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Parcel.
ParcelDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Parcel.
CustomFieldsDraft	getCustom()	Custom Fields for the Parcel.
List<DeliveryItem>	getItems()	Line Items or Custom Line Items delivered in this Parcel.
String	getKey()	User-defined unique identifier of the Parcel.
ParcelMeasurements	getMeasurements()	Information about the dimensions for the Parcel.
TrackingData	getTrackingData()	Shipment tracking information for the Parcel.
ParcelDraftBuilder	items(DeliveryItem... items)	Line Items or Custom Line Items delivered in this Parcel.
ParcelDraftBuilder	items(List<DeliveryItem> items)	Line Items or Custom Line Items delivered in this Parcel.
ParcelDraftBuilder	key(String key)	User-defined unique identifier of the Parcel.
ParcelDraftBuilder	measurements(ParcelMeasurements measurements)	Information about the dimensions for the Parcel.
ParcelDraftBuilder	measurements(Function<ParcelMeasurementsBuilder,ParcelMeasurementsBuilder> builder)	Information about the dimensions for the Parcel.
static ParcelDraftBuilder	of()	factory method for an instance of ParcelDraftBuilder
static ParcelDraftBuilder	of(ParcelDraft template)	create builder for ParcelDraft instance
ParcelDraftBuilder	plusItems(DeliveryItem... items)	Line Items or Custom Line Items delivered in this Parcel.
ParcelDraftBuilder	plusItems(Function<DeliveryItemBuilder,DeliveryItemBuilder> builder)	Line Items or Custom Line Items delivered in this Parcel.
ParcelDraftBuilder	setItems(Function<DeliveryItemBuilder,DeliveryItem> builder)	Line Items or Custom Line Items delivered in this Parcel.
ParcelDraftBuilder	trackingData(TrackingData trackingData)	Shipment tracking information for the Parcel.
ParcelDraftBuilder	trackingData(Function<TrackingDataBuilder,TrackingDataBuilder> builder)	Shipment tracking information for the Parcel.
ParcelDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Parcel.
ParcelDraftBuilder	withItems(Function<DeliveryItemBuilder,DeliveryItemBuilder> builder)	Line Items or Custom Line Items delivered in this Parcel.
ParcelDraftBuilder	withMeasurements(Function<ParcelMeasurementsBuilder,ParcelMeasurements> builder)	Information about the dimensions for the Parcel.
ParcelDraftBuilder	withTrackingData(Function<TrackingDataBuilder,TrackingData> builder)	Shipment tracking information for the Parcel.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ParcelDraftBuilder

public ParcelDraftBuilder()

Method Details

key

public ParcelDraftBuilder key(@Nullable
 String key)

User-defined unique identifier of the Parcel.

Parameters:

key - value to be set

Returns:

Builder

measurements

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

Information about the dimensions for the Parcel.

Parameters:

builder - function to build the measurements value

Returns:

Builder

withMeasurements

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

Information about the dimensions for the Parcel.

Parameters:

builder - function to build the measurements value

Returns:

Builder

measurements

public ParcelDraftBuilder measurements(@Nullable
 ParcelMeasurements measurements)

Information about the dimensions for the Parcel.

Parameters:

measurements - value to be set

Returns:

Builder

trackingData

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

Shipment tracking information for the Parcel.

Parameters:

builder - function to build the trackingData value

Returns:

Builder

withTrackingData

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

Shipment tracking information for the Parcel.

Parameters:

builder - function to build the trackingData value

Returns:

Builder

trackingData

public ParcelDraftBuilder trackingData(@Nullable
 TrackingData trackingData)

Shipment tracking information for the Parcel.

Parameters:

trackingData - value to be set

Returns:

Builder

items

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

Line Items or Custom Line Items delivered in this Parcel.

Parameters:

items - value to be set

Returns:

Builder

items

public ParcelDraftBuilder 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 ParcelDraftBuilder plusItems(@Nullable
 DeliveryItem... items)

Line Items or Custom Line Items delivered in this Parcel.

Parameters:

items - value to be set

Returns:

Builder

plusItems

public ParcelDraftBuilder 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 ParcelDraftBuilder 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 ParcelDraftBuilder 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 ParcelDraftBuilder 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 ParcelDraftBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields for the Parcel.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public ParcelDraftBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields for the Parcel.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public ParcelDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Parcel.

Parameters:

custom - value to be set

Returns:

Builder

getKey

@Nullable
public String getKey()

User-defined unique identifier of the Parcel.

Returns:

key

getMeasurements

@Nullable
public ParcelMeasurements getMeasurements()

Information about the dimensions for the Parcel.

Returns:

measurements

getTrackingData

@Nullable
public TrackingData getTrackingData()

Shipment tracking information for 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 CustomFieldsDraft getCustom()

Custom Fields for the Parcel.

Returns:

custom

build

public ParcelDraft build()

builds ParcelDraft with checking for non-null required values

Specified by:

build in interface Builder<ParcelDraft>

Returns:

ParcelDraft

buildUnchecked

public ParcelDraft buildUnchecked()

builds ParcelDraft without checking for non-null required values

Returns:

ParcelDraft

of

public static ParcelDraftBuilder of()

factory method for an instance of ParcelDraftBuilder

Returns:

builder

of

public static ParcelDraftBuilder of(ParcelDraft template)

create builder for ParcelDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder