Package com.commercetools.api.models.cart

Class ShippingInfoBuilder

java.lang.Object

com.commercetools.api.models.cart.ShippingInfoBuilder

All Implemented Interfaces:

Builder<ShippingInfo>

public class ShippingInfoBuilder
extends Object
implements Builder<ShippingInfo>

ShippingInfoBuilder Example to create an instance using the builder pattern

     ShippingInfo shippingInfo = ShippingInfo.builder()
             .shippingMethodName("{shippingMethodName}")
             .price(priceBuilder -> priceBuilder)
             .shippingRate(shippingRateBuilder -> shippingRateBuilder)
             .shippingMethodState(ShippingMethodState.DOES_NOT_MATCH_CART)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ShippingInfoBuilder()

Method Summary

Modifier and Type	Method	Description
ShippingInfoBuilder	addDeliveries(Function<DeliveryBuilder,Delivery> builder)	Information on how items are delivered to customers.
ShippingInfo	build()	builds ShippingInfo with checking for non-null required values
ShippingInfo	buildUnchecked()	builds ShippingInfo without checking for non-null required values
ShippingInfoBuilder	deliveries(Delivery... deliveries)	Information on how items are delivered to customers.
ShippingInfoBuilder	deliveries(List<Delivery> deliveries)	Information on how items are delivered to customers.
ShippingInfoBuilder	discountedPrice(DiscountedLineItemPrice discountedPrice)	Discounted price of the Shipping Method.
ShippingInfoBuilder	discountedPrice(Function<DiscountedLineItemPriceBuilder,DiscountedLineItemPriceBuilder> builder)	Discounted price of the Shipping Method.
List<Delivery>	getDeliveries()	Information on how items are delivered to customers.
DiscountedLineItemPrice	getDiscountedPrice()	Discounted price of the Shipping Method.
CentPrecisionMoney	getPrice()	Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field.
ShippingMethodReference	getShippingMethod()	Not set if a custom Shipping Method is used.
String	getShippingMethodName()	Name of the Shipping Method.
ShippingMethodState	getShippingMethodState()	Indicates whether the ShippingMethod referenced in this ShippingInfo is allowed for the Cart.
ShippingRate	getShippingRate()	Used to determine the price.
TaxCategoryReference	getTaxCategory()	Used to select a Tax Rate when a Cart has the Platform TaxMode.
TaxedItemPrice	getTaxedPrice()	Automatically set after the taxRate is set.
TaxRate	getTaxRate()	Automatically set in the Platform TaxMode after the shipping address is set.
static ShippingInfoBuilder	of()	factory method for an instance of ShippingInfoBuilder
static ShippingInfoBuilder	of(ShippingInfo template)	create builder for ShippingInfo instance
ShippingInfoBuilder	plusDeliveries(Delivery... deliveries)	Information on how items are delivered to customers.
ShippingInfoBuilder	plusDeliveries(Function<DeliveryBuilder,DeliveryBuilder> builder)	Information on how items are delivered to customers.
ShippingInfoBuilder	price(CentPrecisionMoney price)	Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field.
ShippingInfoBuilder	price(Function<CentPrecisionMoneyBuilder,CentPrecisionMoneyBuilder> builder)	Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field.
ShippingInfoBuilder	setDeliveries(Function<DeliveryBuilder,Delivery> builder)	Information on how items are delivered to customers.
ShippingInfoBuilder	shippingMethod(ShippingMethodReference shippingMethod)	Not set if a custom Shipping Method is used.
ShippingInfoBuilder	shippingMethod(Function<ShippingMethodReferenceBuilder,ShippingMethodReferenceBuilder> builder)	Not set if a custom Shipping Method is used.
ShippingInfoBuilder	shippingMethodName(String shippingMethodName)	Name of the Shipping Method.
ShippingInfoBuilder	shippingMethodState(ShippingMethodState shippingMethodState)	Indicates whether the ShippingMethod referenced in this ShippingInfo is allowed for the Cart.
ShippingInfoBuilder	shippingRate(ShippingRate shippingRate)	Used to determine the price.
ShippingInfoBuilder	shippingRate(Function<ShippingRateBuilder,ShippingRateBuilder> builder)	Used to determine the price.
ShippingInfoBuilder	taxCategory(TaxCategoryReference taxCategory)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
ShippingInfoBuilder	taxCategory(Function<TaxCategoryReferenceBuilder,TaxCategoryReferenceBuilder> builder)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
ShippingInfoBuilder	taxedPrice(TaxedItemPrice taxedPrice)	Automatically set after the taxRate is set.
ShippingInfoBuilder	taxedPrice(Function<TaxedItemPriceBuilder,TaxedItemPriceBuilder> builder)	Automatically set after the taxRate is set.
ShippingInfoBuilder	taxRate(TaxRate taxRate)	Automatically set in the Platform TaxMode after the shipping address is set.
ShippingInfoBuilder	taxRate(Function<TaxRateBuilder,TaxRateBuilder> builder)	Automatically set in the Platform TaxMode after the shipping address is set.
ShippingInfoBuilder	withDeliveries(Function<DeliveryBuilder,DeliveryBuilder> builder)	Information on how items are delivered to customers.
ShippingInfoBuilder	withDiscountedPrice(Function<DiscountedLineItemPriceBuilder,DiscountedLineItemPrice> builder)	Discounted price of the Shipping Method.
ShippingInfoBuilder	withPrice(Function<CentPrecisionMoneyBuilder,CentPrecisionMoney> builder)	Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field.
ShippingInfoBuilder	withShippingMethod(Function<ShippingMethodReferenceBuilder,ShippingMethodReference> builder)	Not set if a custom Shipping Method is used.
ShippingInfoBuilder	withShippingRate(Function<ShippingRateBuilder,ShippingRate> builder)	Used to determine the price.
ShippingInfoBuilder	withTaxCategory(Function<TaxCategoryReferenceBuilder,TaxCategoryReference> builder)	Used to select a Tax Rate when a Cart has the Platform TaxMode.
ShippingInfoBuilder	withTaxedPrice(Function<TaxedItemPriceBuilder,TaxedItemPrice> builder)	Automatically set after the taxRate is set.
ShippingInfoBuilder	withTaxRate(Function<TaxRateBuilder,TaxRate> builder)	Automatically set in the Platform TaxMode after the shipping address is set.

Methods inherited from class java.lang.Object

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

Constructor Details

ShippingInfoBuilder

public ShippingInfoBuilder()

Method Details

shippingMethodName

public ShippingInfoBuilder shippingMethodName(String shippingMethodName)

Name of the Shipping Method.

Parameters:

shippingMethodName - value to be set

Returns:

Builder

price

public ShippingInfoBuilder price(Function<CentPrecisionMoneyBuilder,CentPrecisionMoneyBuilder> builder)

Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field.

Parameters:

builder - function to build the price value

Returns:

Builder

withPrice

public ShippingInfoBuilder withPrice(Function<CentPrecisionMoneyBuilder,CentPrecisionMoney> builder)

Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field.

Parameters:

builder - function to build the price value

Returns:

Builder

price

public ShippingInfoBuilder price(CentPrecisionMoney price)

Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field.

Parameters:

price - value to be set

Returns:

Builder

shippingRate

public ShippingInfoBuilder shippingRate(Function<ShippingRateBuilder,ShippingRateBuilder> builder)

Used to determine the price.

Parameters:

builder - function to build the shippingRate value

Returns:

Builder

withShippingRate

public ShippingInfoBuilder withShippingRate(Function<ShippingRateBuilder,ShippingRate> builder)

Used to determine the price.

Parameters:

builder - function to build the shippingRate value

Returns:

Builder

shippingRate

public ShippingInfoBuilder shippingRate(ShippingRate shippingRate)

Used to determine the price.

Parameters:

shippingRate - value to be set

Returns:

Builder

taxedPrice

public ShippingInfoBuilder taxedPrice(Function<TaxedItemPriceBuilder,TaxedItemPriceBuilder> builder)

Automatically set after the taxRate is set.

Parameters:

builder - function to build the taxedPrice value

Returns:

Builder

withTaxedPrice

public ShippingInfoBuilder withTaxedPrice(Function<TaxedItemPriceBuilder,TaxedItemPrice> builder)

Automatically set after the taxRate is set.

Parameters:

builder - function to build the taxedPrice value

Returns:

Builder

taxedPrice

public ShippingInfoBuilder taxedPrice(@Nullable
 TaxedItemPrice taxedPrice)

Automatically set after the taxRate is set.

Parameters:

taxedPrice - value to be set

Returns:

Builder

taxRate

public ShippingInfoBuilder taxRate(Function<TaxRateBuilder,TaxRateBuilder> builder)

Automatically set in the Platform TaxMode after the shipping address is set.

For the External TaxMode the Tax Rate must be set explicitly with the ExternalTaxRateDraft.

Parameters:

builder - function to build the taxRate value

Returns:

Builder

withTaxRate

public ShippingInfoBuilder withTaxRate(Function<TaxRateBuilder,TaxRate> builder)

Automatically set in the Platform TaxMode after the shipping address is set.

For the External TaxMode the Tax Rate must be set explicitly with the ExternalTaxRateDraft.

Parameters:

builder - function to build the taxRate value

Returns:

Builder

taxRate

public ShippingInfoBuilder taxRate(@Nullable
 TaxRate taxRate)

Automatically set in the Platform TaxMode after the shipping address is set.

For the External TaxMode the Tax Rate must be set explicitly with the ExternalTaxRateDraft.

Parameters:

taxRate - value to be set

Returns:

Builder

taxCategory

public ShippingInfoBuilder taxCategory(Function<TaxCategoryReferenceBuilder,TaxCategoryReferenceBuilder> builder)

Used to select a Tax Rate when a Cart has the Platform TaxMode.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

withTaxCategory

public ShippingInfoBuilder withTaxCategory(Function<TaxCategoryReferenceBuilder,TaxCategoryReference> builder)

Used to select a Tax Rate when a Cart has the Platform TaxMode.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

taxCategory

public ShippingInfoBuilder taxCategory(@Nullable
 TaxCategoryReference taxCategory)

Used to select a Tax Rate when a Cart has the Platform TaxMode.

Parameters:

taxCategory - value to be set

Returns:

Builder

shippingMethod

public ShippingInfoBuilder shippingMethod(Function<ShippingMethodReferenceBuilder,ShippingMethodReferenceBuilder> builder)

Not set if a custom Shipping Method is used.

Parameters:

builder - function to build the shippingMethod value

Returns:

Builder

withShippingMethod

public ShippingInfoBuilder withShippingMethod(Function<ShippingMethodReferenceBuilder,ShippingMethodReference> builder)

Not set if a custom Shipping Method is used.

Parameters:

builder - function to build the shippingMethod value

Returns:

Builder

shippingMethod

public ShippingInfoBuilder shippingMethod(@Nullable
 ShippingMethodReference shippingMethod)

Not set if a custom Shipping Method is used.

Parameters:

shippingMethod - value to be set

Returns:

Builder

deliveries

public ShippingInfoBuilder deliveries(@Nullable
 Delivery... deliveries)

Information on how items are delivered to customers.

Parameters:

deliveries - value to be set

Returns:

Builder

deliveries

public ShippingInfoBuilder deliveries(@Nullable
 List<Delivery> deliveries)

Information on how items are delivered to customers.

Parameters:

deliveries - value to be set

Returns:

Builder

plusDeliveries

public ShippingInfoBuilder plusDeliveries(@Nullable
 Delivery... deliveries)

Information on how items are delivered to customers.

Parameters:

deliveries - value to be set

Returns:

Builder

plusDeliveries

public ShippingInfoBuilder plusDeliveries(Function<DeliveryBuilder,DeliveryBuilder> builder)

Information on how items are delivered to customers.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

withDeliveries

public ShippingInfoBuilder withDeliveries(Function<DeliveryBuilder,DeliveryBuilder> builder)

Information on how items are delivered to customers.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

addDeliveries

public ShippingInfoBuilder addDeliveries(Function<DeliveryBuilder,Delivery> builder)

Information on how items are delivered to customers.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

setDeliveries

public ShippingInfoBuilder setDeliveries(Function<DeliveryBuilder,Delivery> builder)

Information on how items are delivered to customers.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

discountedPrice

public ShippingInfoBuilder discountedPrice(Function<DiscountedLineItemPriceBuilder,DiscountedLineItemPriceBuilder> builder)

Discounted price of the Shipping Method.

Parameters:

builder - function to build the discountedPrice value

Returns:

Builder

withDiscountedPrice

public ShippingInfoBuilder withDiscountedPrice(Function<DiscountedLineItemPriceBuilder,DiscountedLineItemPrice> builder)

Discounted price of the Shipping Method.

Parameters:

builder - function to build the discountedPrice value

Returns:

Builder

discountedPrice

public ShippingInfoBuilder discountedPrice(@Nullable
 DiscountedLineItemPrice discountedPrice)

Discounted price of the Shipping Method.

Parameters:

discountedPrice - value to be set

Returns:

Builder

shippingMethodState

public ShippingInfoBuilder shippingMethodState(ShippingMethodState shippingMethodState)

Indicates whether the ShippingMethod referenced in this ShippingInfo is allowed for the Cart.

Parameters:

shippingMethodState - value to be set

Returns:

Builder

getShippingMethodName

public String getShippingMethodName()

Name of the Shipping Method.

Returns:

shippingMethodName

getPrice

public CentPrecisionMoney getPrice()

Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field.

Returns:

price

getShippingRate

public ShippingRate getShippingRate()

Used to determine the price.

Returns:

shippingRate

getTaxedPrice

@Nullable
public TaxedItemPrice getTaxedPrice()

Automatically set after the taxRate is set.

Returns:

taxedPrice

getTaxRate

@Nullable
public TaxRate getTaxRate()

Automatically set in the Platform TaxMode after the shipping address is set.

For the External TaxMode the Tax Rate must be set explicitly with the ExternalTaxRateDraft.

Returns:

taxRate

getTaxCategory

@Nullable
public TaxCategoryReference getTaxCategory()

Used to select a Tax Rate when a Cart has the Platform TaxMode.

Returns:

taxCategory

getShippingMethod

@Nullable
public ShippingMethodReference getShippingMethod()

Not set if a custom Shipping Method is used.

Returns:

shippingMethod

getDeliveries

@Nullable
public List<Delivery> getDeliveries()

Information on how items are delivered to customers.

Returns:

deliveries

getDiscountedPrice

@Nullable
public DiscountedLineItemPrice getDiscountedPrice()

Discounted price of the Shipping Method.

Returns:

discountedPrice

getShippingMethodState

public ShippingMethodState getShippingMethodState()

Indicates whether the ShippingMethod referenced in this ShippingInfo is allowed for the Cart.

Returns:

shippingMethodState

build

public ShippingInfo build()

builds ShippingInfo with checking for non-null required values

Specified by:

build in interface Builder<ShippingInfo>

Returns:

ShippingInfo

buildUnchecked

public ShippingInfo buildUnchecked()

builds ShippingInfo without checking for non-null required values

Returns:

ShippingInfo

of

public static ShippingInfoBuilder of()

factory method for an instance of ShippingInfoBuilder

Returns:

builder

of

public static ShippingInfoBuilder of(ShippingInfo template)

create builder for ShippingInfo instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder