Package org.cyclos.utils

Class BigDecimalHelper

java.lang.Object

org.cyclos.utils.BigDecimalHelper

public class BigDecimalHelper
extends Object

Helper class for handling BigDecimals.

Field Summary

Fields

Modifier and Type	Field	Description
static MathContext	MATH_CONTEXT	A math context with precision = 15 + MAX_SCALE, with RoundingMode.HALF_UP
static int	MAX_SCALE
static BigDecimal	ONE_HUNDRED

Constructor Summary

Constructors

Constructor	Description
BigDecimalHelper()

Method Summary

Modifier and Type	Method	Description
static boolean	areEquals(BigDecimal bd1, BigDecimal bd2)
static boolean	areEqualsOrBothNull(BigDecimal bd1, BigDecimal bd2)
static int	compareTo(BigDecimal bd1, BigDecimal bd2)
static int	hashCode(BigDecimal bd1)
static boolean	isNegative(BigDecimal number)	Returns whether the given number is a negative, non-zero number, given a precision delta
static boolean	isNegativeOrZero(BigDecimal number)	Returns whether the given number is a negative or zero number, given a precision delta
static boolean	isPositive(BigDecimal number)	Returns whether the given number is a positive, non-zero number, given a precision delta
static boolean	isPositiveOrZero(BigDecimal number)	Returns whether the given number is a positive or zero number, given a precision delta
static boolean	isZero(BigDecimal number)	Returns whether the given number is a negative, non-zero number, given a precision delta
static BigDecimal	max(BigDecimal bd1, BigDecimal bd2)
static BigDecimal	min(BigDecimal bd1, BigDecimal bd2)
static BigDecimal	negative(BigDecimal bigDecimal)	Returns a negative representation of the given number.
static BigDecimal	positive(BigDecimal bigDecimal)	Returns a positive representation of the given number.
static BigDecimal	round(BigDecimal number, int scale)	Rounds the given number to the given scale
static BigDecimal	toBigDecimal(String intPart, String decimalPart)	Converts the given integer part and decimal part to a BigDecimal value.
static BigDecimal	zeroWhenNull(BigDecimal bigDecimal)	Returns zero when the given BigDecimal is null

Methods inherited from class java.lang.Object

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

Field Detail

ONE_HUNDRED

public static final BigDecimal ONE_HUNDRED

MAX_SCALE

public static final int MAX_SCALE

MATH_CONTEXT

public static final MathContext MATH_CONTEXT

A math context with precision = 15 + MAX_SCALE, with RoundingMode.HALF_UP

Constructor Detail

BigDecimalHelper

public BigDecimalHelper()

Method Detail

areEquals

public static boolean areEquals(BigDecimal bd1,
                                BigDecimal bd2)

areEqualsOrBothNull

public static boolean areEqualsOrBothNull(BigDecimal bd1,
                                          BigDecimal bd2)

compareTo

public static int compareTo(BigDecimal bd1,
                            BigDecimal bd2)

hashCode

public static int hashCode(BigDecimal bd1)

isNegative

public static boolean isNegative(BigDecimal number)

Returns whether the given number is a negative, non-zero number, given a precision delta

isNegativeOrZero

public static boolean isNegativeOrZero(BigDecimal number)

Returns whether the given number is a negative or zero number, given a precision delta

isPositive

public static boolean isPositive(BigDecimal number)

Returns whether the given number is a positive, non-zero number, given a precision delta

isPositiveOrZero

public static boolean isPositiveOrZero(BigDecimal number)

Returns whether the given number is a positive or zero number, given a precision delta

isZero

public static boolean isZero(BigDecimal number)

Returns whether the given number is a negative, non-zero number, given a precision delta

max

public static BigDecimal max(BigDecimal bd1,
                             BigDecimal bd2)

min

public static BigDecimal min(BigDecimal bd1,
                             BigDecimal bd2)

negative

public static BigDecimal negative(BigDecimal bigDecimal)

Returns a negative representation of the given number. If null or already negative, return as is. Otherwise, returns the negated value.

positive

public static BigDecimal positive(BigDecimal bigDecimal)

Returns a positive representation of the given number. If null or already positive, return as is. Otherwise, returns the negated value.

round

public static BigDecimal round(BigDecimal number,
                               int scale)

Rounds the given number to the given scale

toBigDecimal

public static BigDecimal toBigDecimal(String intPart,
                                      String decimalPart)

Converts the given integer part and decimal part to a BigDecimal value. If either is null, returns null.

zeroWhenNull

public static BigDecimal zeroWhenNull(BigDecimal bigDecimal)

Returns zero when the given BigDecimal is null