Package com.commercetools.history.models.common

Class MoneyBuilder

java.lang.Object

com.commercetools.history.models.common.MoneyBuilder

All Implemented Interfaces:

Builder<Money>

public class MoneyBuilder
extends Object
implements Builder<Money>

MoneyBuilder Example to create an instance using the builder pattern

     Money money = Money.builder()
             .centAmount(0.3)
             .currencyCode("{currencyCode}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
MoneyBuilder()

Method Summary

Modifier and Type	Method	Description
Money	build()	builds Money with checking for non-null required values
Money	buildUnchecked()	builds Money without checking for non-null required values
MoneyBuilder	centAmount(Long centAmount)	Amount in the smallest indivisible unit of a currency, such as:
MoneyBuilder	currencyCode(String currencyCode)	Currency code compliant to ISO 4217.
Long	getCentAmount()	Amount in the smallest indivisible unit of a currency, such as:
String	getCurrencyCode()	Currency code compliant to ISO 4217.
static MoneyBuilder	of()	factory method for an instance of MoneyBuilder
static MoneyBuilder	of(Money template)	create builder for Money instance

Methods inherited from class java.lang.Object

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

Constructor Details

MoneyBuilder

public MoneyBuilder()

Method Details

centAmount

public MoneyBuilder centAmount(Long centAmount)

Amount in the smallest indivisible unit of a currency, such as:

• Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
• The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).

Parameters:

centAmount - value to be set

Returns:

Builder

currencyCode

public MoneyBuilder currencyCode(String currencyCode)

Currency code compliant to ISO 4217.

Parameters:

currencyCode - value to be set

Returns:

Builder

getCentAmount

public Long getCentAmount()

Amount in the smallest indivisible unit of a currency, such as:

• Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
• The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).

Returns:

centAmount

getCurrencyCode

public String getCurrencyCode()

Currency code compliant to ISO 4217.

Returns:

currencyCode

build

public Money build()

builds Money with checking for non-null required values

Specified by:

build in interface Builder<Money>

Returns:

Money

buildUnchecked

public Money buildUnchecked()

builds Money without checking for non-null required values

Returns:

Money

of

public static MoneyBuilder of()

factory method for an instance of MoneyBuilder

Returns:

builder

of

public static MoneyBuilder of(Money template)

create builder for Money instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder