org.kuali.kfs.module.cam.util
Class KualiDecimalUtils

java.lang.Object
  org.kuali.kfs.module.cam.util.KualiDecimalUtils

public class KualiDecimalUtils
extends Object

Utility class that divides currency into equal targets with remainder to cents in some buckets.

Constructor Summary

KualiDecimalUtils()
Default constructor.

KualiDecimalUtils(org.kuali.rice.kns.util.KualiDecimal totalAmount, Currency currencyCode)
Constructs a KualiDecimalService.

Method Summary

org.kuali.rice.kns.util.KualiDecimal[]	allocateByQuantity(int divisor) Allocate a sum of money amongst many targets by quantity.
static org.kuali.rice.kns.util.KualiDecimal[]	allocateByRatio(org.kuali.rice.kns.util.KualiDecimal amount, double[] ratios) Allocate a sum of money amongst many targets by ratio.
org.kuali.rice.kns.util.KualiDecimal	safeMultiply(org.kuali.rice.kns.util.KualiDecimal value, double multiplier) Makes sure no null pointer exception occurs on fields that can accurately be null when multiplying.
org.kuali.rice.kns.util.KualiDecimal	safeSubtract(org.kuali.rice.kns.util.KualiDecimal value, org.kuali.rice.kns.util.KualiDecimal subtrahend) Makes sure no null pointer exception occurs on fields that can accurately be null when subtracting.

Methods inherited from class java.lang.Object

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

Constructor Detail

KualiDecimalUtils

public KualiDecimalUtils()

Default constructor.

KualiDecimalUtils

public KualiDecimalUtils(org.kuali.rice.kns.util.KualiDecimal totalAmount,
                         Currency currencyCode)

Constructs a KualiDecimalService.

Parameters:

amount -

currency -

Method Detail

allocateByQuantity

public org.kuali.rice.kns.util.KualiDecimal[] allocateByQuantity(int divisor)

Allocate a sum of money amongst many targets by quantity.

Parameters:

divisor -

Returns:

KualiDecimal[]

allocateByRatio

public static org.kuali.rice.kns.util.KualiDecimal[] allocateByRatio(org.kuali.rice.kns.util.KualiDecimal amount,
                                                                     double[] ratios)

Allocate a sum of money amongst many targets by ratio.

Parameters:

divisor -

Returns:

KualiDecimal[]

safeMultiply

public org.kuali.rice.kns.util.KualiDecimal safeMultiply(org.kuali.rice.kns.util.KualiDecimal value,
                                                         double multiplier)

Makes sure no null pointer exception occurs on fields that can accurately be null when multiplying. If either field are null the value is returned.

Parameters:

value -

multiplier -

Returns:

safeSubtract

public org.kuali.rice.kns.util.KualiDecimal safeSubtract(org.kuali.rice.kns.util.KualiDecimal value,
                                                         org.kuali.rice.kns.util.KualiDecimal subtrahend)

Makes sure no null pointer exception occurs on fields that can accurately be null when subtracting. If either field are null the value is returned.

Parameters:

value -

subtrahend -

Returns: