Package com.broadleafcommerce.orderoperation.service.split

Class SplitTotalRounder.SplitAmount

java.lang.Object

com.broadleafcommerce.orderoperation.service.split.SplitTotalRounder.SplitAmount

Enclosing class:

SplitTotalRounder

public static class SplitTotalRounder.SplitAmount
extends Object

Represents an amount value that has been split into multiple new amounts.

Tracks the original value of the amount, to allow adjusting the split amounts so that they sum to that total once rounded.

Constructor Summary

Constructors

Constructor	Description
SplitAmount(List<javax.money.MonetaryAmount> splitAmounts, javax.money.MonetaryAmount unitAmount)
SplitAmount(List<javax.money.MonetaryAmount> splitAmounts, javax.money.MonetaryAmount originalTotal, javax.money.MonetaryAmount unitAmount)

Method Summary

Modifier and Type	Method	Description
javax.money.MonetaryAmount	getOriginalTotal()
protected javax.money.MonetaryAmount	getRemainder(javax.money.MonetaryAmount amount)	Get the remainder of the amount compared to its rounded floor value.
Integer	getScale()
List<javax.money.MonetaryAmount>	getSplitAmounts()
List<javax.money.MonetaryAmount>	getSplitRemainders()
javax.money.MonetaryAmount	getUnitAmount()
int	getUnitsOffTotal()
void	increment(int index)	Adds a unit to the amount at a certain index.
void	roundAmounts()	Rounds the contained amounts so that the split amounts sum to the original total.
void	roundFloor()	Round the contained amounts to the floor, and calculates how many units the new sum of rounded amounts is off from the original total.
protected javax.money.MonetaryAmount	roundFloor(javax.money.MonetaryAmount amount)
protected void	setScale(Integer scale)
protected void	setSplitAmounts(List<javax.money.MonetaryAmount> splitAmounts)
protected void	setUnitsOffTotal(int unitsOffTotal)

Methods inherited from class java.lang.Object

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

Constructor Details

SplitAmount

public SplitAmount(List<javax.money.MonetaryAmount> splitAmounts,
 javax.money.MonetaryAmount unitAmount)

SplitAmount

public SplitAmount(List<javax.money.MonetaryAmount> splitAmounts,
 javax.money.MonetaryAmount originalTotal,
 javax.money.MonetaryAmount unitAmount)

Method Details

getRemainder

protected javax.money.MonetaryAmount getRemainder(javax.money.MonetaryAmount amount)

Get the remainder of the amount compared to its rounded floor value.

Parameters:

amount - the amount to get the remainder for compared to its floor value

Returns:

the positive amount lost when then value is rounded to floor

roundFloor

public void roundFloor()

Round the contained amounts to the floor, and calculates how many units the new sum of rounded amounts is off from the original total.

This is a prerequisite step to take prior to rounding.

roundFloor

protected javax.money.MonetaryAmount roundFloor(javax.money.MonetaryAmount amount)

increment

public void increment(int index)

Adds a unit to the amount at a certain index.

roundAmounts

public void roundAmounts()

Rounds the contained amounts so that the split amounts sum to the original total.

All amounts are first rounded to floor, and then units are distributed for each side of the split.

Does not account for each split amount adding up to any other totals. See SplitTotalRounder.roundAmounts() for that functionality.

getOriginalTotal

public javax.money.MonetaryAmount getOriginalTotal()

getUnitAmount

public javax.money.MonetaryAmount getUnitAmount()

getSplitAmounts

public List<javax.money.MonetaryAmount> getSplitAmounts()

getSplitRemainders

public List<javax.money.MonetaryAmount> getSplitRemainders()

getUnitsOffTotal

public int getUnitsOffTotal()

getScale

@Nullable
public Integer getScale()

setSplitAmounts

protected void setSplitAmounts(List<javax.money.MonetaryAmount> splitAmounts)

setUnitsOffTotal

protected void setUnitsOffTotal(int unitsOffTotal)

setScale

protected void setScale(@Nullable
 Integer scale)