Interface Parcel
- All Superinterfaces:
Customizable<Parcel>
,ParcelMixin
- All Known Implementing Classes:
ParcelImpl
Parcel
Example to create an instance using the builder pattern
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()
-
Method Summary
Modifier and TypeMethodDescriptionstatic ParcelBuilder
builder()
builder factory method for Parcelstatic ParcelBuilder
create builder for Parcel instancestatic Parcel
factory method to create a deep copy of Parcel@NotNull ZonedDateTime
@Valid CustomFields
Custom Fields of this parcel.@NotNull String
getId()
Unique identifier of the Parcel.@Valid List<DeliveryItem>
getItems()
The delivery items contained in this parcel.getKey()
User-defined unique identifier of the Parcel.@Valid ParcelMeasurements
@Valid TrackingData
static Parcel
of()
factory methodstatic Parcel
factory method to create a shallow copy Parcelvoid
setCreatedAt
(ZonedDateTime createdAt) set createdAtvoid
setCustom
(CustomFields custom) Custom Fields of this parcel.void
Unique identifier of the Parcel.void
setItems
(DeliveryItem... items) The delivery items contained in this parcel.void
setItems
(List<DeliveryItem> items) The delivery items contained in this parcel.void
User-defined unique identifier of the Parcel.void
setMeasurements
(ParcelMeasurements measurements) set measurementsvoid
setTrackingData
(TrackingData trackingData) set trackingDatastatic com.fasterxml.jackson.core.type.TypeReference<Parcel>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
withParcel
(Function<Parcel, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.Customizable
unwrapCustomizable
Methods inherited from interface com.commercetools.api.models.order.ParcelMixin
toDraft, toDraftBuilder
-
Method Details
-
getId
Unique identifier of the Parcel.
- Returns:
- id
-
getKey
User-defined unique identifier of the Parcel.
- Returns:
- key
-
getCreatedAt
- Returns:
- createdAt
-
getMeasurements
- Specified by:
getMeasurements
in interfaceParcelMixin
- Returns:
- measurements
-
getTrackingData
- Specified by:
getTrackingData
in interfaceParcelMixin
- Returns:
- trackingData
-
getItems
The delivery items contained in this parcel.
- Specified by:
getItems
in interfaceParcelMixin
- Returns:
- items
-
getCustom
Custom Fields of this parcel.
- Specified by:
getCustom
in interfaceCustomizable<Parcel>
- Specified by:
getCustom
in interfaceParcelMixin
- Returns:
- custom
-
setId
Unique identifier of the Parcel.
- Parameters:
id
- value to be set
-
setKey
User-defined unique identifier of the Parcel.
- Parameters:
key
- value to be set
-
setCreatedAt
set createdAt- Parameters:
createdAt
- value to be set
-
setMeasurements
set measurements- Parameters:
measurements
- value to be set
-
setTrackingData
set trackingData- Parameters:
trackingData
- value to be set
-
setItems
The delivery items contained in this parcel.
- Parameters:
items
- values to be set
-
setItems
The delivery items contained in this parcel.
- Parameters:
items
- values to be set
-
setCustom
Custom Fields of this parcel.
- Specified by:
setCustom
in interfaceCustomizable<Parcel>
- Parameters:
custom
- value to be set
-
of
factory method- Returns:
- instance of Parcel
-
of
factory method to create a shallow copy Parcel- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
factory method to create a deep copy of Parcel- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for Parcel- Returns:
- builder
-
builder
create builder for Parcel instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withParcel
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-