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 provides methods to allocate money into a number of targets according to certain policies. Note: It's assumed that the currency we use here is US dollar.

Constructor Summary

Constructors

Constructor and Description
KualiDecimalUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static org.kuali.rice.core.api.util.type.KualiDecimal[]	allocateByQuantity(org.kuali.rice.core.api.util.type.KualiDecimal amount, int divisor) Allocates evenly a sum of money amongst a number of targets.
static org.kuali.rice.core.api.util.type.KualiDecimal[]	allocateByRatio(org.kuali.rice.core.api.util.type.KualiDecimal amount, double[] ratios) Allocates by ratio a sum of money amongst a number of targets.
static org.kuali.rice.core.api.util.type.KualiDecimal	safeMultiply(org.kuali.rice.core.api.util.type.KualiDecimal value, double multiplier) Makes sure no null pointer exception occurs on fields that can accurately be null when multiplying.
static org.kuali.rice.core.api.util.type.KualiDecimal	safeSubtract(org.kuali.rice.core.api.util.type.KualiDecimal value, org.kuali.rice.core.api.util.type.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()

Method Detail

allocateByQuantity

public static org.kuali.rice.core.api.util.type.KualiDecimal[] allocateByQuantity(org.kuali.rice.core.api.util.type.KualiDecimal amount,
                                                                  int divisor)

Allocates evenly a sum of money amongst a number of targets. Note: 1. This method assumes that the divisor is a positive integer. Validation of the the passed in parameters shall be the caller's responsibility. 2. If the sum can't be evenly divided due to limited accuracy, the last few elements will be adjusted (each by 1c) to reflect the round-up difference.

Parameters:

amount - the total amount to allocate

divisor - the number of targets to allocate to

Returns:

an array of allocated amounts

allocateByRatio

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

Allocates by ratio a sum of money amongst a number of targets. Note: 1. This method assumes that 0 < ratio < 1 and all ratios sum up to 1. Validation of the the passed in parameters shall be the caller's responsibility. 2. If the allocated amount doesn't sum up to exactly the total amount due to limited accuracy, the last few elements will be adjusted (each by 1c) to reflect the round-up difference.

Parameters:

amount - the total amount to allocate

ratios - an array of ratios according to which the total amount is to be allocated

Returns:

an array of allocated amounts

safeMultiply

public static org.kuali.rice.core.api.util.type.KualiDecimal safeMultiply(org.kuali.rice.core.api.util.type.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 static org.kuali.rice.core.api.util.type.KualiDecimal safeSubtract(org.kuali.rice.core.api.util.type.KualiDecimal value,
                                                          org.kuali.rice.core.api.util.type.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: