org.decimal4j.arithmetic

Class BigDecimalConversion

java.lang.Object

org.decimal4j.arithmetic.BigDecimalConversion

final class BigDecimalConversion
extends Object

Contains methods to convert from and to BigDecimal.

Method Summary

Modifier and Type	Method and Description
static long	bigDecimalToLong(RoundingMode roundingMode, BigDecimal value) Converts the specified big decimal value to a long value applying the given rounding mode.
static long	bigDecimalToUnscaled(ScaleMetrics scaleMetrics, RoundingMode roundingMode, BigDecimal value) Converts the specified big decimal value to an unscaled decimal applying the given rounding mode if necessary.
static BigDecimal	unscaledToBigDecimal(ScaleMetrics scaleMetrics, long uDecimal) Converts the given unscaled decimal value to a BigDecimal of the same scale as the given decimal value.
static BigDecimal	unscaledToBigDecimal(ScaleMetrics scaleMetrics, RoundingMode roundingMode, long uDecimal, int targetScale) Converts the given unscaled decimal value to a BigDecimal of the specified targetScale rounding the value if necessary.

Methods inherited from class java.lang.Object

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

Method Detail

bigDecimalToLong

public static final long bigDecimalToLong(RoundingMode roundingMode,
                                          BigDecimal value)

Converts the specified big decimal value to a long value applying the given rounding mode. An exception is thrown if the value exceeds the valid long range.

Parameters:

roundingMode - the rounding mode to apply if necessary

value - the big decimal value to convert

Returns:

round(value)

Throws:

IllegalArgumentException - if the value is outside of the valid long range

ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary

bigDecimalToUnscaled

public static final long bigDecimalToUnscaled(ScaleMetrics scaleMetrics,
                                              RoundingMode roundingMode,
                                              BigDecimal value)

Converts the specified big decimal value to an unscaled decimal applying the given rounding mode if necessary. An exception is thrown if the value exceeds the valid Decimal range.

Parameters:

scaleMetrics - the scale metrics of the result value

roundingMode - the rounding mode to apply if necessary

value - the big decimal value to convert

Returns:

round(value)

Throws:

IllegalArgumentException - if the value is outside of the valid Decimal range

ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary

unscaledToBigDecimal

public static final BigDecimal unscaledToBigDecimal(ScaleMetrics scaleMetrics,
                                                    long uDecimal)

Converts the given unscaled decimal value to a BigDecimal of the same scale as the given decimal value.

Parameters:

scaleMetrics - the scale metrics associated with the unscaled value

uDecimal - the unscaled decimal value to convert

Returns:

a big decimal with the scale from scale metrics

unscaledToBigDecimal

public static final BigDecimal unscaledToBigDecimal(ScaleMetrics scaleMetrics,
                                                    RoundingMode roundingMode,
                                                    long uDecimal,
                                                    int targetScale)

Converts the given unscaled decimal value to a BigDecimal of the specified targetScale rounding the value if necessary.

Parameters:

scaleMetrics - the scale metrics associated with the unscaled value

roundingMode - the rounding mode to use if rounding is necessary

uDecimal - the unscaled decimal value to convert

targetScale - the scale of the result value

Returns:

a big decimal with the specified targetScale

Throws:

ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary