BigDecimalUtil (ObjectLab Kit 1.4.8 API)

java.lang.Object
- net.objectlab.kit.util.BigDecimalUtil

public final class BigDecimalUtil
extends Object

Author:: Benoit Xhenseval

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static BigDecimal`	`abs(BigDecimal value)` Returns the ABS of the value, handles null.
`static int`	`absCompareTo(BigDecimal v1, BigDecimal v2)`
`static BigDecimal`	`absDiff(BigDecimal v1, BigDecimal v2)`
`static BigDecimal`	`add(BigDecimal start, BigDecimal... values)` Add n BigDecimal safely (i.e.
`static BigDecimal`	`addWeightedConstituent(BigDecimal runningWeightedVal, BigDecimal valueToAdd, BigDecimal weightForValueToAdd, BigDecimal totalWeight)` Calculate the weight of the constituent and add it to the running weighted value.
`static boolean`	`allNullOrZero(BigDecimal... values)`
`static BigDecimal`	`assignNonNull(BigDecimal o1, BigDecimal fallBack)`
`static BigDecimal`	`bd(String val)` Convenience method to create a BigDecimal with a String, can be statically imported.
`static BigDecimal`	`bigSqrt(BigDecimal c)` Uses Newton Raphson to compute the square root of a BigDecimal.
`static BigDecimal`	`calculateWeight(BigDecimal value, BigDecimal total)`
`static int`	`compareTo(BigDecimal v1, BigDecimal v2)`
`static BigDecimal`	`decimalPart(BigDecimal val)` Return the decimal part of the value.
`static BigDecimal`	`divide(BigDecimal numerator, BigDecimal denominator, int rounding)`
`static BigDecimal`	`divide(BigDecimal numerator, BigDecimal denominator, int scale, int rounding)`
`static BigDecimal`	`divide(int numeratorScale, BigDecimal numerator, BigDecimal denominator, int rounding)`
`static double`	`doubleValue(BigDecimal val)`
`static BigDecimal`	`ensureMin(BigDecimal minimum, BigDecimal value)` Return minimum if the value is < minimum.
`static BigDecimal`	`forceNegative(BigDecimal amount)` Return a negative amount based on amount.
`static BigDecimal`	`forceNegativeIfTrue(boolean condition, BigDecimal amount)` Return a negative amount based on amount if true, otherwise return the ABS.
`static String`	`format(BigDecimal bd)` return a Number formatted or empty string if null.
`static boolean`	`hasSignedChanged(BigDecimal v1, BigDecimal v2)`
`static boolean`	`hasSignedFlippedAndNotZero(BigDecimal v1, BigDecimal v2)`
`static boolean`	`ifNotNull(BigDecimal bd, Consumer<BigDecimal> consumer)` If the BigDecimal is not null call the consumer (depends on JDK8+)
`static BigDecimal`	`inverse(BigDecimal value)` Return the inverse of value if no tnull of zero
`static BigDecimal`	`inverse(BigDecimal value, int scale)` Return the inverse of value if not null or zero, using scale.
`static BigDecimal`	`inverse(BigDecimal value, int scale, int rounding)` Return the inverse of value if not null or zero, using scale.
`static boolean`	`isDiffMoreThanAbsThreshold(BigDecimal v1, BigDecimal v2, BigDecimal threshold)`
`static boolean`	`isInsideInclusiveRange(BigDecimal bd, BigDecimal lowerLimit, BigDecimal upperLimit)`
`static boolean`	`isNegative(BigDecimal value)`
`static boolean`	`isNotSameAbsValue(BigDecimal v1, BigDecimal v2)` Check ABS values of v1 and v2.
`static boolean`	`isNotSameValue(BigDecimal v1, BigDecimal v2)` Check values of v1 and v2.
`static boolean`	`isNotZero(BigDecimal value)`
`static boolean`	`isNullOrZero(BigDecimal value)`
`static boolean`	`isOutsideRange(BigDecimal bd, BigDecimal lowerLimit, BigDecimal upperLimit)`
`static boolean`	`isSameAbsValue(BigDecimal v1, BigDecimal v2)` Check ABS values of v1 and v2.
`static boolean`	`isSameSignum(BigDecimal v1, BigDecimal v2)`
`static boolean`	`isSameValue(BigDecimal val1, BigDecimal val2)`
`static boolean`	`isSameValueTreatNullAsZero(BigDecimal val1, BigDecimal val2)`
`static boolean`	`isStrictlyPositive(BigDecimal value)`
`static boolean`	`isZero(BigDecimal value)`
`static boolean`	`isZeroOrLess(BigDecimal value)`
`static long`	`longForFraction(BigDecimal v)` Move by 2 DEC place to the left and take the long value, this takes care of values like 0.18 in fractions.
`static BigDecimal`	`max(BigDecimal... v1)`
`static BigDecimal`	`min(BigDecimal v1, BigDecimal v2)`
`static boolean`	`movedInsideThresholdPercentage(BigDecimal startValue, BigDecimal newValue, BigDecimal thresholdPercent)` true if ABS((startValue-newValue)/startValue) <= abs(thresholdPercent)
`static boolean`	`movedStrictlyOutsideThresholdPercentage(BigDecimal startValue, BigDecimal newValue, BigDecimal thresholdPercent)` true if ABS((startValue-newValue)/startValue) > abs(thresholdPercent)
`static BigDecimal`	`movePoint(BigDecimal v1, int shift)` Safe shift (check for null), shift RIGHT if shift>0.
`static BigDecimal`	`multiply(BigDecimal value, BigDecimal... multiplicand)`
`static BigDecimal`	`multiply(BigDecimal value, BigDecimal multiplicand)`
`static BigDecimal`	`negate(BigDecimal value)` Returns the negate of the value, handles null.
`static BigDecimal`	`negateIfTrue(boolean condition, BigDecimal value)` Returns the negate of the value if condition is true, handles null.
`static String`	`percentFormat(BigDecimal bd)` return a Number formatted or empty string if null.
`static BigDecimal`	`roundDown(BigDecimal n, int p)` Returns a value rounded to p digits after decimal.
`static BigDecimal`	`roundDownForIncrement(BigDecimal n, BigDecimal increment)`
`static BigDecimal`	`roundTo(BigDecimal bd, int numberOfDecPlaces, int finalScale)` returns a new BigDecimal with correct scale after being round to n dec places.
`static BigDecimal`	`roundUp(BigDecimal n, int p)` Returns a value rounded-up to p digits after decimal.
`static BigDecimal`	`roundUpForIncrement(BigDecimal n, BigDecimal increment)`
`static BigDecimal`	`setScale(BigDecimal bd, int scale)` returns a new BigDecimal with correct scale.
`static BigDecimal`	`setScale(BigDecimal bd, Integer scale)` returns a new BigDecimal with correct Scale.
`static BigDecimal`	`setScale(BigDecimal bd, Integer scale, int rounding)` returns a new BigDecimal with correct Scales.PERCENT_SCALE.
`static int`	`signum(BigDecimal value)` If value is null return 0 otherwise the signum().
`static BigDecimal`	`subtract(BigDecimal start, BigDecimal... values)` Subtract n BigDecimal safely from the start value (i.e.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

ifNotNull
```
public static boolean ifNotNull(BigDecimal bd,
                                Consumer<BigDecimal> consumer)
```
If the BigDecimal is not null call the consumer (depends on JDK8+)

Parameters:

bd - the BigDecimal

consumer - of the value, called if not null

Returns:

true if consumed

Since:

1.4.0

bd
```
public static BigDecimal bd(String val)
```
Convenience method to create a BigDecimal with a String, can be statically imported.

Parameters:

val - a string representing the BigDecimal

Returns:

the new BigDecimal

inverse
```
public static BigDecimal inverse(BigDecimal value,
                                 int scale)
```
Return the inverse of value if not null or zero, using scale.

Parameters:

value - the nullable BigDecimal

scale - scale for the result if value is not null

Returns:

1 / value (if not null of zero)

inverse
```
public static BigDecimal inverse(BigDecimal value,
                                 int scale,
                                 int rounding)
```
Return the inverse of value if not null or zero, using scale.

Parameters:

value - the nullable BigDecimal

scale - scale for the result if value is not null

rounding - the rounding (see BigDecimal)

Returns:

1 / value (if not null of zero)

inverse
```
public static BigDecimal inverse(BigDecimal value)
```
Return the inverse of value if no tnull of zero

Parameters:

value - the nullable BigDecimal

Returns:

1 / value (if not null of zero)

isNotZero
```
public static boolean isNotZero(BigDecimal value)
```
Parameters:

value - the nullable BigDecimal

Returns:

true if value !=null and <gt; 0.

isZero
```
public static boolean isZero(BigDecimal value)
```
Parameters:

value - the nullable BigDecimal

Returns:

true if value !=null and 0.

isNegative
```
public static boolean isNegative(BigDecimal value)
```
Parameters:

value - the nullable BigDecimal

Returns:

true if value !=null and < 0.

isStrictlyPositive
```
public static boolean isStrictlyPositive(BigDecimal value)
```
Parameters:

value - the nullable BigDecimal

Returns:

true if value !=null and >0.

isNullOrZero
```
public static boolean isNullOrZero(BigDecimal value)
```
Parameters:

value - the nullable BigDecimal

Returns:

true if value ==null OR 0.

isSameValue
```
public static boolean isSameValue(BigDecimal val1,
                                  BigDecimal val2)
```
Parameters:

val1 - the nullable BigDecimal

val2 - the nullable BigDecimal

Returns:

true if val1 == val2 (ignoring scale and null are treated as 0)

isSameValueTreatNullAsZero

public static boolean isSameValueTreatNullAsZero(BigDecimal val1,
                                                 BigDecimal val2)

Parameters:: val1 - the nullable BigDecimal; val2 - the nullable BigDecimal
Returns:: true if val1 == val2 (ignoring scale and null are treated as 0)

add
```
public static BigDecimal add(BigDecimal start,
                             BigDecimal... values)
```
Add n BigDecimal safely (i.e. handles nulls)

Parameters:

start - initial BigDecimal

values - series of BigDecimals can be null/empty

Returns:

the sum of the n non null BigDecimals

subtract
```
public static BigDecimal subtract(BigDecimal start,
                                  BigDecimal... values)
```
Subtract n BigDecimal safely from the start value (i.e. handles nulls as zeros), returns 0

Parameters:

start - starting point, if null, use 0

values - series of BigDecimal to subtract from start, can be null / empty

Returns:

start - the series of values

divide

public static BigDecimal divide(BigDecimal numerator,
                                BigDecimal denominator,
                                int rounding)

Returns:: numerator / denominator if they are not null and the denominator is not zero, it returns null otherwise.

calculateWeight

public static BigDecimal calculateWeight(BigDecimal value,
                                         BigDecimal total)

divide

public static BigDecimal divide(int numeratorScale,
                                BigDecimal numerator,
                                BigDecimal denominator,
                                int rounding)

Returns:: numerator / denominator if they are not null and the denominator is not zero, it returns null otherwise.

divide

public static BigDecimal divide(BigDecimal numerator,
                                BigDecimal denominator,
                                int scale,
                                int rounding)

Returns:: numerator / denominator if they are not null and the denominator is not zero, it returns null otherwise.

multiply

public static BigDecimal multiply(BigDecimal value,
                                  BigDecimal multiplicand)

multiply

public static BigDecimal multiply(BigDecimal value,
                                  BigDecimal... multiplicand)

abs
```
public static BigDecimal abs(BigDecimal value)
```
Returns the ABS of the value, handles null.

Parameters:

value - nullable BigDecimal

Returns:

abs(value) or null if null

negate
```
public static BigDecimal negate(BigDecimal value)
```
Returns the negate of the value, handles null.

Parameters:

value - nullable BigDecimal

Returns:

-value or null if null

negateIfTrue
```
public static BigDecimal negateIfTrue(boolean condition,
                                      BigDecimal value)
```
Returns the negate of the value if condition is true, handles null.

Parameters:

condition - triggers negate

value - nullable BigDecimal

Returns:

-value if condition==true

isNotSameAbsValue

public static boolean isNotSameAbsValue(BigDecimal v1,
                                        BigDecimal v2)

Check ABS values of v1 and v2.

Parameters:: v1 - nullable BigDecimal; v2 - nullable BigDecimal
Returns:: false if the ABS value match!

isNotSameValue

public static boolean isNotSameValue(BigDecimal v1,
                                     BigDecimal v2)

Check values of v1 and v2.

Parameters:: v1 - nullable BigDecimal; v2 - nullable BigDecimal
Returns:: false if the value match!

isSameAbsValue

public static boolean isSameAbsValue(BigDecimal v1,
                                     BigDecimal v2)

Check ABS values of v1 and v2.

Parameters:: v1 - nullable BigDecimal; v2 - nullable BigDecimal
Returns:: true if the ABS value match!

compareTo

public static int compareTo(BigDecimal v1,
                            BigDecimal v2)

Returns:: 1 if v1 > v2 or v2==null and v2!=null

absCompareTo

public static int absCompareTo(BigDecimal v1,
                               BigDecimal v2)

Returns:: true if the ABS(v1) > ABS(v2)

absDiff

public static BigDecimal absDiff(BigDecimal v1,
                                 BigDecimal v2)

Returns:: true if the ABS( ABS(v1) - ABS(v2) )

movePoint

public static BigDecimal movePoint(BigDecimal v1,
                                   int shift)

Safe shift (check for null), shift RIGHT if shift>0.

roundTo
```
public static BigDecimal roundTo(BigDecimal bd,
                                 int numberOfDecPlaces,
                                 int finalScale)
```
returns a new BigDecimal with correct scale after being round to n dec places.

Parameters:

bd - value

numberOfDecPlaces - number of dec place to round to

finalScale - final scale of result (typically numberOfDecPlaces < finalScale);

Returns:

new bd or null

setScale

public static BigDecimal setScale(BigDecimal bd,
                                  int scale)

returns a new BigDecimal with correct scale.

Parameters:: bd -
Returns:: new bd or null

setScale

public static BigDecimal setScale(BigDecimal bd,
                                  Integer scale)

returns a new BigDecimal with correct Scale.

Parameters:: bd -
Returns:: new bd or null

setScale

public static BigDecimal setScale(BigDecimal bd,
                                  Integer scale,
                                  int rounding)

returns a new BigDecimal with correct Scales.PERCENT_SCALE. This is used by the table renderer.

Parameters:: bd -
Returns:: new bd or null

signum
```
public static int signum(BigDecimal value)
```
If value is null return 0 otherwise the signum().

Parameters:

value -

Returns:

isSameSignum

public static boolean isSameSignum(BigDecimal v1,
                                   BigDecimal v2)

Returns:: true if both v1/v2 are null or same sign.

hasSignedFlippedAndNotZero

public static boolean hasSignedFlippedAndNotZero(BigDecimal v1,
                                                 BigDecimal v2)

Returns:: true if both v1.signum() != v2.signum() and NOT zero.

hasSignedChanged

public static boolean hasSignedChanged(BigDecimal v1,
                                       BigDecimal v2)

Returns:: true if v1.signum() != v2.signum().

isOutsideRange

public static boolean isOutsideRange(BigDecimal bd,
                                     BigDecimal lowerLimit,
                                     BigDecimal upperLimit)

Parameters:: bd -; lowerLimit -; upperLimit -
Returns:: true if outside the range

isInsideInclusiveRange

public static boolean isInsideInclusiveRange(BigDecimal bd,
                                             BigDecimal lowerLimit,
                                             BigDecimal upperLimit)

Parameters:: bd -; lowerLimit -; upperLimit -
Returns:: true if inside the inclusive range

assignNonNull

public static BigDecimal assignNonNull(BigDecimal o1,
                                       BigDecimal fallBack)

Returns:: o1 if not null, otherwise fallBack

addWeightedConstituent

public static BigDecimal addWeightedConstituent(BigDecimal runningWeightedVal,
                                                BigDecimal valueToAdd,
                                                BigDecimal weightForValueToAdd,
                                                BigDecimal totalWeight)

Calculate the weight of the constituent and add it to the running weighted value. runningWeightedVal + valueToAdd * weightForValueToAdd / totalWeight

Parameters:: runningWeightedVal -; valueToAdd -; weightForValueToAdd -; totalWeight -
Returns:

allNullOrZero
```
public static boolean allNullOrZero(BigDecimal... values)
```
Returns:

true if all values are either null or zero

format
```
public static String format(BigDecimal bd)
```
return a Number formatted or empty string if null.

Parameters:

bd -

percentFormat
```
public static String percentFormat(BigDecimal bd)
```
return a Number formatted or empty string if null.

Parameters:

bd -

movedInsideThresholdPercentage

public static boolean movedInsideThresholdPercentage(BigDecimal startValue,
                                                     BigDecimal newValue,
                                                     BigDecimal thresholdPercent)

true if ABS((startValue-newValue)/startValue) <= abs(thresholdPercent)

Parameters:: startValue -; newValue -; thresholdPercent -
Returns:

movedStrictlyOutsideThresholdPercentage

public static boolean movedStrictlyOutsideThresholdPercentage(BigDecimal startValue,
                                                              BigDecimal newValue,
                                                              BigDecimal thresholdPercent)

true if ABS((startValue-newValue)/startValue) > abs(thresholdPercent)

Parameters:: startValue -; newValue -; thresholdPercent -
Returns:

roundUp
```
public static BigDecimal roundUp(BigDecimal n,
                                 int p)
```
Returns a value rounded-up to p digits after decimal. If p is negative, then the number is rounded to places to the left of the decimal point. eg. 10.23 rounded to -1 will give: 20. If p is zero, the returned value is rounded to the nearest integral value.
If n is negative, the resulting value is obtained as the round-up value of absolute value of n multiplied by the sign value of n (@see MathX.sign(double d)). Thus, -0.2 rounded-up to p=0 will give -1 not 0.
If n is NaN, returned value is NaN.

Parameters:

n -

p -

Returns:

roundDown
```
public static BigDecimal roundDown(BigDecimal n,
                                   int p)
```
Returns a value rounded to p digits after decimal. If p is negative, then the number is rounded to places to the left of the decimal point. eg. 10.23 rounded to -1 will give: 10. If p is zero, the returned value is rounded to the nearest integral value.
If n is negative, the resulting value is obtained as the round-up value of absolute value of n multiplied by the sign value of n (@see MathX.sign(double d)). Thus, -0.8 rounded-down to p=0 will give 0 not -1.
If n is NaN, returned value is NaN.

Parameters:

n -

p -

Returns:

roundUpForIncrement

public static BigDecimal roundUpForIncrement(BigDecimal n,
                                             BigDecimal increment)

roundDownForIncrement

public static BigDecimal roundDownForIncrement(BigDecimal n,
                                               BigDecimal increment)

ensureMin

public static BigDecimal ensureMin(BigDecimal minimum,
                                   BigDecimal value)

Return minimum if the value is < minimum.

forceNegative

public static BigDecimal forceNegative(BigDecimal amount)

Return a negative amount based on amount.

forceNegativeIfTrue

public static BigDecimal forceNegativeIfTrue(boolean condition,
                                             BigDecimal amount)

Return a negative amount based on amount if true, otherwise return the ABS.

min

public static BigDecimal min(BigDecimal v1,
                             BigDecimal v2)

Returns:: return the min amount

max

public static BigDecimal max(BigDecimal... v1)

Returns:: return the max amount

longForFraction
```
public static long longForFraction(BigDecimal v)
```
Move by 2 DEC place to the left and take the long value, this takes care of values like 0.18 in fractions.

isDiffMoreThanAbsThreshold

public static boolean isDiffMoreThanAbsThreshold(BigDecimal v1,
                                                 BigDecimal v2,
                                                 BigDecimal threshold)

Returns:: true if abs(abs(v1)-abs(v2)) < abs(threshold)

doubleValue

public static double doubleValue(BigDecimal val)

isZeroOrLess

public static boolean isZeroOrLess(BigDecimal value)

Returns:: true if value !=null and <=0.

decimalPart
```
public static BigDecimal decimalPart(BigDecimal val)
```
Return the decimal part of the value.

Parameters:

val -

bigSqrt
```
public static BigDecimal bigSqrt(BigDecimal c)
```
Uses Newton Raphson to compute the square root of a BigDecimal.

Parameters:

c - the BigDecimal for which we want the SQRT.

See Also:

http://www.codeproject.com/Tips/257031/Implementing-SqrtRoot-in-BigDecimal

Class BigDecimalUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

ifNotNull

bd

inverse

inverse

inverse

isNotZero

isZero

isNegative

isStrictlyPositive

isNullOrZero

isSameValue

isSameValueTreatNullAsZero

add

subtract

divide

calculateWeight

divide

divide

multiply

multiply

abs

negate

negateIfTrue

isNotSameAbsValue

isNotSameValue

isSameAbsValue

compareTo

absCompareTo

absDiff

movePoint

roundTo

setScale

setScale

setScale

signum

isSameSignum

hasSignedFlippedAndNotZero

hasSignedChanged

isOutsideRange

isInsideInclusiveRange

assignNonNull

addWeightedConstituent

allNullOrZero

format

percentFormat

movedInsideThresholdPercentage

movedStrictlyOutsideThresholdPercentage

roundUp

roundDown

roundUpForIncrement

roundDownForIncrement

ensureMin

forceNegative

forceNegativeIfTrue

min

max

longForFraction

isDiffMoreThanAbsThreshold

doubleValue

isZeroOrLess

decimalPart

bigSqrt