Package com.commercetools.api.models.common

Class DiscountedPriceBuilder

java.lang.Object

com.commercetools.api.models.common.DiscountedPriceBuilder

All Implemented Interfaces:

Builder<DiscountedPrice>

public class DiscountedPriceBuilder
extends Object
implements Builder<DiscountedPrice>

DiscountedPriceBuilder Example to create an instance using the builder pattern

     DiscountedPrice discountedPrice = DiscountedPrice.builder()
             .value(valueBuilder -> valueBuilder)
             .discount(discountBuilder -> discountBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
DiscountedPriceBuilder()

Method Summary

Modifier and Type	Method	Description
DiscountedPrice	build()	builds DiscountedPrice with checking for non-null required values
DiscountedPrice	buildUnchecked()	builds DiscountedPrice without checking for non-null required values
DiscountedPriceBuilder	discount(ProductDiscountReference discount)	ProductDiscount related to the discounted price.
DiscountedPriceBuilder	discount(Function<ProductDiscountReferenceBuilder,ProductDiscountReferenceBuilder> builder)	ProductDiscount related to the discounted price.
ProductDiscountReference	getDiscount()	ProductDiscount related to the discounted price.
TypedMoney	getValue()	Money value of the discounted price.
static DiscountedPriceBuilder	of()	factory method for an instance of DiscountedPriceBuilder
static DiscountedPriceBuilder	of(DiscountedPrice template)	create builder for DiscountedPrice instance
DiscountedPriceBuilder	value(TypedMoney value)	Money value of the discounted price.
DiscountedPriceBuilder	value(Function<TypedMoneyBuilder,Builder<? extends TypedMoney>> builder)	Money value of the discounted price.
DiscountedPriceBuilder	withDiscount(Function<ProductDiscountReferenceBuilder,ProductDiscountReference> builder)	ProductDiscount related to the discounted price.

Methods inherited from class java.lang.Object

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

Constructor Details

DiscountedPriceBuilder

public DiscountedPriceBuilder()

Method Details

value

public DiscountedPriceBuilder value(TypedMoney value)

Money value of the discounted price.

• When a relative Product Discount applies and the fractional part of the resulting discounted price is 0.5, the discounted price is rounded half down.

  For example, a price of €1.01 (centAmount: 101) with a 50% discount (permyriad: 5000) calculates to €0.505. Since the fractional half-cent is exactly 0.5, it rounds down to €0.50 (centAmount: 50).

• When an absolute Product Discount exceeds the price of the Product Variant, the resulting discounted price is set to 0.

Parameters:

value - value to be set

Returns:

Builder

value

public DiscountedPriceBuilder value(Function<TypedMoneyBuilder,Builder<? extends TypedMoney>> builder)

Money value of the discounted price.

• When a relative Product Discount applies and the fractional part of the resulting discounted price is 0.5, the discounted price is rounded half down.

  For example, a price of €1.01 (centAmount: 101) with a 50% discount (permyriad: 5000) calculates to €0.505. Since the fractional half-cent is exactly 0.5, it rounds down to €0.50 (centAmount: 50).

• When an absolute Product Discount exceeds the price of the Product Variant, the resulting discounted price is set to 0.

Parameters:

builder - function to build the value value

Returns:

Builder

discount

public DiscountedPriceBuilder discount(Function<ProductDiscountReferenceBuilder,ProductDiscountReferenceBuilder> builder)

ProductDiscount related to the discounted price.

Parameters:

builder - function to build the discount value

Returns:

Builder

withDiscount

public DiscountedPriceBuilder withDiscount(Function<ProductDiscountReferenceBuilder,ProductDiscountReference> builder)

ProductDiscount related to the discounted price.

Parameters:

builder - function to build the discount value

Returns:

Builder

discount

public DiscountedPriceBuilder discount(ProductDiscountReference discount)

ProductDiscount related to the discounted price.

Parameters:

discount - value to be set

Returns:

Builder

getValue

public TypedMoney getValue()

Money value of the discounted price.

• When a relative Product Discount applies and the fractional part of the resulting discounted price is 0.5, the discounted price is rounded half down.

  For example, a price of €1.01 (centAmount: 101) with a 50% discount (permyriad: 5000) calculates to €0.505. Since the fractional half-cent is exactly 0.5, it rounds down to €0.50 (centAmount: 50).

• When an absolute Product Discount exceeds the price of the Product Variant, the resulting discounted price is set to 0.

Returns:

value

getDiscount

public ProductDiscountReference getDiscount()

ProductDiscount related to the discounted price.

Returns:

discount

build

public DiscountedPrice build()

builds DiscountedPrice with checking for non-null required values

Specified by:

build in interface Builder<DiscountedPrice>

Returns:

DiscountedPrice

buildUnchecked

public DiscountedPrice buildUnchecked()

builds DiscountedPrice without checking for non-null required values

Returns:

DiscountedPrice

of

public static DiscountedPriceBuilder of()

factory method for an instance of DiscountedPriceBuilder

Returns:

builder

of

public static DiscountedPriceBuilder of(DiscountedPrice template)

create builder for DiscountedPrice instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder