Package com.commercetools.api.models.common

Class HighPrecisionMoneyDraftImpl

java.lang.Object

com.commercetools.api.models.common.HighPrecisionMoneyDraftImpl

All Implemented Interfaces:

HighPrecisionMoneyDraft, MonetaryAmountConvertable, Money, TypedMoneyDraft, io.vrap.rmf.base.client.Draft<HighPrecisionMoneyDraft>, io.vrap.rmf.base.client.ModelBase, Comparable<javax.money.MonetaryAmount>, javax.money.CurrencySupplier, javax.money.MonetaryAmount, javax.money.NumberSupplier

public class HighPrecisionMoneyDraftImpl
extends Object
implements HighPrecisionMoneyDraft, io.vrap.rmf.base.client.ModelBase

Money draft object to store an amount of a fraction of the smallest indivisible unit of the specified currency.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Field Summary

Fields inherited from interface com.commercetools.api.models.common.HighPrecisionMoneyDraft

HIGH_PRECISION

Constructor Summary

Constructors

Constructor	Description
HighPrecisionMoneyDraftImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Long	getCentAmount()	Amount in the smallest indivisible unit of a currency.
String	getCurrencyCode()	Currency code compliant to ISO 4217.
Integer	getFractionDigits()	Number of fraction digits for a specified high precision money.
Long	getPreciseAmount()	Amount in 1 / (10 ^ fractionDigits) of a currency.
MoneyType	getType()
int	hashCode()
void	setCentAmount(Long centAmount)	Amount in the smallest indivisible unit of a currency.
void	setCurrencyCode(String currencyCode)
void	setFractionDigits(Integer fractionDigits)	Number of fraction digits for a specified high precision money.
void	setPreciseAmount(Long preciseAmount)	Amount in 1 / (10 ^ fractionDigits) of a currency.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.commercetools.api.models.common.HighPrecisionMoneyDraft

createMoneyOperator, withHighPrecisionMoneyDraft

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Methods inherited from interface javax.money.MonetaryAmount

isNegative, isNegativeOrZero, isPositive, isPositiveOrZero, isZero

Methods inherited from interface com.commercetools.api.models.common.MonetaryAmountConvertable

toMonetaryAmount

Methods inherited from interface com.commercetools.api.models.common.Money

abs, add, compareTo, divide, divide, divide, divideAndRemainder, divideAndRemainder, divideAndRemainder, divideToIntegralValue, divideToIntegralValue, divideToIntegralValue, getContext, getCurrency, getFactory, getNumber, isEqualTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, multiply, multiply, multiply, negate, plus, query, remainder, remainder, remainder, scaleByPowerOfTen, signum, stripTrailingZeros, subtract, toDraft, with, withMoney

Methods inherited from interface com.commercetools.api.models.common.TypedMoneyDraft

withTypedMoneyDraft

Constructor Details

HighPrecisionMoneyDraftImpl

public HighPrecisionMoneyDraftImpl()

create empty instance

Method Details

getCentAmount

public Long getCentAmount()

Amount in the smallest indivisible unit of a currency. This field is optional for high precision. If provided, it is checked for validity. Example:

A Price of 1.015 USD can be rounded either to 1.01 USD or 1.02 USD. If it lies outside of this range, an error message stating that centAmount must be rounded correctly will be returned.

If centAmount is not provided, the API calculates the value automatically using the default rounding mode half even.

Specified by:

getCentAmount in interface HighPrecisionMoneyDraft

Specified by:

getCentAmount in interface Money

Returns:

centAmount

getCurrencyCode

public String getCurrencyCode()

Currency code compliant to ISO 4217.

Specified by:

getCurrencyCode in interface Money

Returns:

currencyCode

getType

public MoneyType getType()

Specified by:

getType in interface TypedMoneyDraft

Returns:

type

getFractionDigits

public Integer getFractionDigits()

Number of fraction digits for a specified high precision money. It must be greater than the default number of fraction digits for the specified currency.

Specified by:

getFractionDigits in interface HighPrecisionMoneyDraft

Specified by:

getFractionDigits in interface TypedMoneyDraft

Returns:

fractionDigits

getPreciseAmount

public Long getPreciseAmount()

Amount in 1 / (10 ^ fractionDigits) of a currency.

Specified by:

getPreciseAmount in interface HighPrecisionMoneyDraft

Returns:

preciseAmount

setCentAmount

public void setCentAmount(Long centAmount)

Description copied from interface: HighPrecisionMoneyDraft

Amount in the smallest indivisible unit of a currency. This field is optional for high precision. If provided, it is checked for validity. Example:

A Price of 1.015 USD can be rounded either to 1.01 USD or 1.02 USD. If it lies outside of this range, an error message stating that centAmount must be rounded correctly will be returned.

If centAmount is not provided, the API calculates the value automatically using the default rounding mode half even.

Specified by:

setCentAmount in interface HighPrecisionMoneyDraft

Specified by:

setCentAmount in interface Money

Parameters:

centAmount - value to be set

setCurrencyCode

public void setCurrencyCode(String currencyCode)

Specified by:

setCurrencyCode in interface Money

setFractionDigits

public void setFractionDigits(Integer fractionDigits)

Description copied from interface: HighPrecisionMoneyDraft

Number of fraction digits for a specified high precision money. It must be greater than the default number of fraction digits for the specified currency.

Specified by:

setFractionDigits in interface HighPrecisionMoneyDraft

Specified by:

setFractionDigits in interface TypedMoneyDraft

Parameters:

fractionDigits - value to be set

setPreciseAmount

public void setPreciseAmount(Long preciseAmount)

Description copied from interface: HighPrecisionMoneyDraft

Amount in 1 / (10 ^ fractionDigits) of a currency.

Specified by:

setPreciseAmount in interface HighPrecisionMoneyDraft

Parameters:

preciseAmount - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object