org.decimal4j.arithmetic

Class UnscaledConversion

java.lang.Object

org.decimal4j.arithmetic.UnscaledConversion

final class UnscaledConversion
extends Object

Contains static methods to convert between different scales.

Method Summary

Methods

Modifier and Type	Method and Description
static long	unscaledToLong(DecimalArithmetic arith, DecimalRounding rounding, long unscaledValue, int scale) Converts the given unscaledValue with the specified scale to a long value.
static long	unscaledToLong(DecimalArithmetic arith, long unscaledValue, int scale) Converts the given unscaledValue with the specified scale to a long value.
static long	unscaledToUnscaled(DecimalArithmetic arith, DecimalRounding rounding, long unscaledValue, int scale) Returns an unscaled value of the scale defined by arith given an unscaledValue with its scale.
static long	unscaledToUnscaled(DecimalArithmetic arith, long unscaledValue, int scale) Returns an unscaled value of the scale defined by arith given an unscaledValue with its scale.
static long	unscaledToUnscaled(DecimalRounding rounding, int targetScale, DecimalArithmetic arith, long uDecimal) Converts an unscaled value uDecimal having the scale specified by arith into another unscaled value of the provided targetScale.
static long	unscaledToUnscaled(int targetScale, DecimalArithmetic arith, long uDecimal) Converts an unscaled value uDecimal having the scale specified by arith into another unscaled value of the provided targetScale.

Methods inherited from class java.lang.Object

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

Method Detail

unscaledToLong

public static final long unscaledToLong(DecimalArithmetic arith,
                  long unscaledValue,
                  int scale)

Converts the given unscaledValue with the specified scale to a long value. The value is rounded DOWN if necessary. An exception is thrown if the conversion is not possible.

Parameters:

arith - arithmetic of the target value

unscaledValue - the unscaled value to convert

scale - the scale of unscaledValue

Returns:

a long value rounded down if necessary

Throws:

IllegalArgumentException - if the conversion cannot be performed due to overflow

unscaledToLong

public static final long unscaledToLong(DecimalArithmetic arith,
                  DecimalRounding rounding,
                  long unscaledValue,
                  int scale)

Converts the given unscaledValue with the specified scale to a long value. The value is rounded using the specified rounding if necessary. An exception is thrown if the conversion is not possible.

Parameters:

arith - arithmetic of the target value

rounding - the rounding to apply if rounding is necessary

unscaledValue - the unscaled value to convert

scale - the scale of unscaledValue

Returns:

long value rounded with given rounding if necessary

Throws:

IllegalArgumentException - if the conversion cannot be performed due to overflow

ArithmeticException - if rounding is necessary and rounding==UNNECESSARY

unscaledToUnscaled

public static final long unscaledToUnscaled(DecimalArithmetic arith,
                      long unscaledValue,
                      int scale)

Returns an unscaled value of the scale defined by arith given an unscaledValue with its scale. The value is rounded DOWN if necessary. An exception is thrown if the conversion is not possible.

Parameters:

arith - arithmetic defining the target scale

unscaledValue - the unscaled value to convert

scale - the scale of unscaledValue

Returns:

the unscaled value in the arithmetic's scale

Throws:

IllegalArgumentException - if the conversion cannot be performed due to overflow

unscaledToUnscaled

public static final long unscaledToUnscaled(DecimalArithmetic arith,
                      DecimalRounding rounding,
                      long unscaledValue,
                      int scale)

Returns an unscaled value of the scale defined by arith given an unscaledValue with its scale. The value is rounded using the specified rounding if necessary. An exception is thrown if the conversion is not possible.

Parameters:

arith - arithmetic defining the target scale

rounding - the rounding to apply if rounding is necessary

unscaledValue - the unscaled value to convert

scale - the scale of unscaledValue

Returns:

the unscaled value in the arithmetic's scale

Throws:

IllegalArgumentException - if the conversion cannot be performed due to overflow

ArithmeticException - if rounding is necessary and rounding==UNNECESSARY

unscaledToUnscaled

public static final long unscaledToUnscaled(int targetScale,
                      DecimalArithmetic arith,
                      long uDecimal)

Converts an unscaled value uDecimal having the scale specified by arith into another unscaled value of the provided targetScale. The value is rounded DOWN if necessary. An exception is thrown if the conversion is not possible.

Parameters:

targetScale - the scale of the result value

arith - arithmetic defining the source scale

uDecimal - the unscaled value to convert

Returns:

the unscaled value with targetScale

Throws:

IllegalArgumentException - if the conversion cannot be performed due to overflow

unscaledToUnscaled

public static final long unscaledToUnscaled(DecimalRounding rounding,
                      int targetScale,
                      DecimalArithmetic arith,
                      long uDecimal)

Converts an unscaled value uDecimal having the scale specified by arith into another unscaled value of the provided targetScale. The value is rounded using the specified rounding if necessary. An exception is thrown if the conversion is not possible.

Parameters:

rounding - the rounding to apply if rounding is necessary

targetScale - the scale of the result value

arith - arithmetic defining the source scale

uDecimal - the unscaled value to convert

Returns:

the unscaled value with targetScale

Throws:

IllegalArgumentException - if the conversion cannot be performed due to overflow