org.decimal4j.arithmetic

Class LongConversion

java.lang.Object

org.decimal4j.arithmetic.LongConversion

final class LongConversion
extends Object

Contains methods to convert from and to long.

Method Summary

Modifier and Type	Method and Description
static long	longToUnscaled(ScaleMetrics scaleMetrics, long value) Converts the specified long value to an unscaled value of the scale defined by the given scaleMetrics.
static long	longToUnscaledUnchecked(ScaleMetrics scaleMetrics, long value) Converts the specified long value to an unscaled value of the scale defined by the given scaleMetrics.
static long	unscaledToLong(ScaleMetrics scaleMetrics, DecimalRounding rounding, long uDecimal) Converts the specified unscaled value to a long rounding the result if necessary.
static long	unscaledToLong(ScaleMetrics scaleMetrics, long uDecimal) Converts the specified unscaled value to a long truncating the result if necessary.

Methods inherited from class java.lang.Object

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

Method Detail

longToUnscaledUnchecked

public static final long longToUnscaledUnchecked(ScaleMetrics scaleMetrics,
                                                 long value)

Converts the specified long value to an unscaled value of the scale defined by the given scaleMetrics. Performs no overflow checks.

Parameters:

scaleMetrics - the scale metrics defining the result scale

value - the long value to convert

Returns:

the value converted to the scale defined by scaleMetrics

longToUnscaled

public static final long longToUnscaled(ScaleMetrics scaleMetrics,
                                        long value)

Converts the specified long value to an unscaled value of the scale defined by the given scaleMetrics. An exception is thrown if an overflow occurs.

Parameters:

scaleMetrics - the scale metrics defining the result scale

value - the long value to convert

Returns:

the value converted to the scale defined by scaleMetrics

Throws:

IllegalArgumentException - if value is too large to be represented as a Decimal with the scale of this factory

unscaledToLong

public static final long unscaledToLong(ScaleMetrics scaleMetrics,
                                        long uDecimal)

Converts the specified unscaled value to a long truncating the result if necessary.

Parameters:

scaleMetrics - the scale metrics associated with uDecimal

uDecimal - the unscaled decimal value to convert

Returns:

roundDOWN(uDecimal)

unscaledToLong

public static final long unscaledToLong(ScaleMetrics scaleMetrics,
                                        DecimalRounding rounding,
                                        long uDecimal)

Converts the specified unscaled value to a long rounding the result if necessary.

Parameters:

scaleMetrics - the scale metrics associated with uDecimal

rounding - the rounding to apply during the conversion if necessary

uDecimal - the unscaled decimal value to convert

Returns:

round(uDecimal)

Throws:

ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary