org.decimal4j.base

Class AbstractImmutableDecimal<S extends ScaleMetrics,D extends AbstractImmutableDecimal<S,D>>

java.lang.Object

java.lang.Number

org.decimal4j.base.AbstractDecimal<S,D>

org.decimal4j.base.AbstractImmutableDecimal<S,D>

Type Parameters:

S - the scale metrics type associated with this decimal

D - the concrete class implementing this ImmutableDecimal

All Implemented Interfaces:

Serializable, Comparable<Decimal<S>>, Decimal<S>, ImmutableDecimal<S>

Direct Known Subclasses:

Decimal0f, Decimal10f, Decimal11f, Decimal12f, Decimal13f, Decimal14f, Decimal15f, Decimal16f, Decimal17f, Decimal18f, Decimal1f, Decimal2f, Decimal3f, Decimal4f, Decimal5f, Decimal6f, Decimal7f, Decimal8f, Decimal9f, GenericImmutableDecimal

public abstract class AbstractImmutableDecimal<S extends ScaleMetrics,D extends AbstractImmutableDecimal<S,D>>
extends AbstractDecimal<S,D>
implements ImmutableDecimal<S>

Base class for immutable Decimal classes of different scales.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractImmutableDecimal(long unscaled) Constructor with unscaled value.

Method Summary

Modifier and Type	Method and Description
ImmutableDecimal<S>	max(ImmutableDecimal<S> val) Returns the maximum of this Decimal and val.
ImmutableDecimal<S>	min(ImmutableDecimal<S> val) Returns the minimum of this Decimal and val.
ImmutableDecimal<?>	multiplyExact(Decimal<?> multiplicand) Returns a Decimal whose value is (this * multiplicand).
ImmutableDecimal<?>	scale(int scale) Returns a Decimal value whose scale is changed to the given scale value.
ImmutableDecimal<?>	scale(int scale, RoundingMode roundingMode) Returns a Decimal value whose scale is changed to the given scale value.
<S extends ScaleMetrics> ImmutableDecimal<S>	scale(S scaleMetrics) Returns a Decimal value whose scale is changed to the scale given by the scaleMetrics argument.
<S extends ScaleMetrics> ImmutableDecimal<S>	scale(S scaleMetrics, RoundingMode roundingMode) Returns a Decimal value whose scale is changed to the scale given by the scaleMetrics argument.
long	unscaledValue() Returns the unscaled value underlying this Decimal.

Methods inherited from class org.decimal4j.base.AbstractDecimal

abs, abs, add, add, add, add, add, add, add, add, addSquared, addSquared, addSquared, addUnscaled, addUnscaled, addUnscaled, addUnscaled, addUnscaled, avg, avg, byteValueExact, compareTo, compareToNumerically, create, createArray, createOrAssign, divide, divide, divide, divide, divide, divide, divide, divide, divideAndRemainder, divideAndRemainder, divideBy, divideBy, divideBy, divideByPowerOfTen, divideByPowerOfTen, divideByPowerOfTen, divideExact, divideToIntegralValue, divideToIntegralValue, divideToLongValue, divideToLongValue, divideTruncate, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, doubleValue, doubleValue, equals, floatValue, floatValue, fractionalPart, getArithmeticFor, getArithmeticFor, getArithmeticFor, getCheckedArithmeticFor, getDefaultArithmetic, getDefaultCheckedArithmetic, getRoundingDownArithmetic, getRoundingFloorArithmetic, getRoundingHalfEvenArithmetic, getRoundingUnnecessaryArithmetic, hashCode, integralPart, intValue, intValueExact, invert, invert, invert, isBetweenZeroAndMinusOne, isBetweenZeroAndOne, isEqualTo, isEqualToNumerically, isGreaterThan, isGreaterThanOrEqualTo, isIntegral, isIntegralPartZero, isLessThan, isLessThanOrEqualTo, isMinusOne, isNegative, isNonNegative, isNonPositive, isOne, isPositive, isUlp, isZero, longValue, longValue, longValueExact, max, max, min, min, multiply, multiply, multiply, multiply, multiply, multiply, multiply, multiplyBy, multiplyBy, multiplyBy, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, negate, negate, pow, pow, pow, remainder, round, round, round, self, shiftLeft, shiftLeft, shiftLeft, shiftRight, shiftRight, shiftRight, shortValueExact, signum, sqrt, sqrt, square, square, square, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtractSquared, subtractSquared, subtractSquared, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled, toBigDecimal, toBigDecimal, toBigInteger, toBigInteger, toBigIntegerExact, toString

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.decimal4j.api.ImmutableDecimal

abs, abs, add, add, add, add, add, add, add, add, addSquared, addSquared, addSquared, addUnscaled, addUnscaled, addUnscaled, addUnscaled, addUnscaled, avg, avg, divide, divide, divide, divide, divide, divide, divide, divide, divideAndRemainder, divideAndRemainder, divideBy, divideBy, divideBy, divideByPowerOfTen, divideByPowerOfTen, divideByPowerOfTen, divideExact, divideToIntegralValue, divideToIntegralValue, divideTruncate, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, fractionalPart, integralPart, invert, invert, invert, multiply, multiply, multiply, multiply, multiply, multiply, multiply, multiplyBy, multiplyBy, multiplyBy, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, negate, negate, pow, pow, pow, remainder, round, round, round, shiftLeft, shiftLeft, shiftLeft, shiftRight, shiftRight, shiftRight, sqrt, sqrt, square, square, square, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtractSquared, subtractSquared, subtractSquared, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled

Methods inherited from interface org.decimal4j.api.Decimal

byteValue, byteValueExact, compareTo, compareToNumerically, divideToLongValue, divideToLongValue, doubleValue, doubleValue, equals, floatValue, floatValue, getFactory, getScale, getScaleMetrics, hashCode, intValue, intValueExact, isBetweenZeroAndMinusOne, isBetweenZeroAndOne, isEqualTo, isEqualToNumerically, isGreaterThan, isGreaterThanOrEqualTo, isIntegral, isIntegralPartZero, isLessThan, isLessThanOrEqualTo, isMinusOne, isNegative, isNonNegative, isNonPositive, isOne, isPositive, isUlp, isZero, longValue, longValue, longValueExact, max, min, shortValue, shortValueExact, signum, toBigDecimal, toBigDecimal, toBigInteger, toBigInteger, toBigIntegerExact, toImmutableDecimal, toMutableDecimal, toString

Constructor Detail

AbstractImmutableDecimal

public AbstractImmutableDecimal(long unscaled)

Constructor with unscaled value.

Parameters:

unscaled - the unscaled value

Method Detail

unscaledValue

public final long unscaledValue()

Description copied from interface: Decimal

Returns the unscaled value underlying this Decimal. This Decimal is (unscaledValue × 10^-f) with f representing the scale, hence the returned value equals (10^f × this).

Specified by:

unscaledValue in interface Decimal<S extends ScaleMetrics>

Returns:

the unscaled numeric value, the same as this Decimal but without applying the scale factor

See Also:

Decimal.getScale(), ScaleMetrics.getScaleFactor()

scale

public ImmutableDecimal<?> scale(int scale)

Description copied from interface: Decimal

Returns a Decimal value whose scale is changed to the given scale value. HALF_UP rounding is used if the scale change involves rounding.

An exception is thrown if the scale conversion leads to an overflow.

Specified by:

scale in interface Decimal<S extends ScaleMetrics>

Specified by:

scale in interface ImmutableDecimal<S extends ScaleMetrics>

Parameters:

scale - the scale to use for the result, must be in [0,18]

Returns:

a Decimal instance with the given new scale

See Also:

Decimal.scale(ScaleMetrics), Decimal.scale(int, RoundingMode), Decimal.round(int)

scale

public <S extends ScaleMetrics> ImmutableDecimal<S> scale(S scaleMetrics)

Description copied from interface: Decimal

Returns a Decimal value whose scale is changed to the scale given by the scaleMetrics argument. HALF_UP rounding is used if the scale change involves rounding.

An exception is thrown if the scale conversion leads to an overflow.

Specified by:

scale in interface Decimal<S extends ScaleMetrics>

Specified by:

scale in interface ImmutableDecimal<S extends ScaleMetrics>

Type Parameters:

S - the scale metrics type of the result

Parameters:

scaleMetrics - the scale metrics to use for the result

Returns:

a Decimal instance with the given new scale metrics

See Also:

Decimal.scale(int), Decimal.scale(ScaleMetrics, RoundingMode), Decimal.round(int)

scale

public ImmutableDecimal<?> scale(int scale,
                                 RoundingMode roundingMode)

Description copied from interface: Decimal

Returns a Decimal value whose scale is changed to the given scale value. The specified roundingMode is used if the scale change involves rounding.

An exception is thrown if the scale conversion leads to an overflow.

Specified by:

scale in interface Decimal<S extends ScaleMetrics>

Specified by:

scale in interface ImmutableDecimal<S extends ScaleMetrics>

Parameters:

scale - the scale to use for the result, must be in [0,18]

roundingMode - the rounding mode to apply if the scale change involves rounding

Returns:

a Decimal instance with the given new scale

See Also:

Decimal.scale(int), Decimal.scale(ScaleMetrics, RoundingMode), Decimal.round(int, RoundingMode)

scale

public <S extends ScaleMetrics> ImmutableDecimal<S> scale(S scaleMetrics,
                                                          RoundingMode roundingMode)

Description copied from interface: Decimal

Returns a Decimal value whose scale is changed to the scale given by the scaleMetrics argument. The specified roundingMode is used if the scale change involves rounding.

An exception is thrown if the scale conversion leads to an overflow.

Specified by:

scale in interface Decimal<S extends ScaleMetrics>

Specified by:

scale in interface ImmutableDecimal<S extends ScaleMetrics>

Type Parameters:

S - the scale metrics type of the result

Parameters:

scaleMetrics - the scale metrics to use for the result

roundingMode - the rounding mode to apply if the scale change involves rounding

Returns:

a Decimal instance with the given new scale metrics

See Also:

Decimal.scale(ScaleMetrics), Decimal.scale(int, RoundingMode), Decimal.round(int, RoundingMode)

multiplyExact

public ImmutableDecimal<?> multiplyExact(Decimal<?> multiplicand)

Description copied from interface: Decimal

Returns a Decimal whose value is (this * multiplicand). The scale of the returned value is the sum of the scales of this Decimal and the multiplicand argument. If the result scale exceeds 18, an IllegalArgumentException is thrown. An ArithmeticException is thrown if the product is out of the possible range for a Decimal with the result scale.

Note that the result is always a new instance --- immutable if this Decimal is an ImmutableDecimal and mutable if it is a MutableDecimal.

Specified by:

multiplyExact in interface Decimal<S extends ScaleMetrics>

Specified by:

multiplyExact in interface ImmutableDecimal<S extends ScaleMetrics>

Parameters:

multiplicand - factor to multiply with this Decimal

Returns:

(this * multiplicand) with scale equal to the sum of scales of this and multiplicand

min

public ImmutableDecimal<S> min(ImmutableDecimal<S> val)

Description copied from interface: ImmutableDecimal

Returns the minimum of this Decimal and val.

Specified by:

min in interface ImmutableDecimal<S extends ScaleMetrics>

Parameters:

val - value with which the minimum is to be computed.

Returns:

the Decimal whose value is the lesser of this Decimal and val. If they are equal, as defined by the compareTo method, this is returned.

See Also:

Decimal.compareTo(Decimal)

max

public ImmutableDecimal<S> max(ImmutableDecimal<S> val)

Description copied from interface: ImmutableDecimal

Returns the maximum of this Decimal and val.

Specified by:

max in interface ImmutableDecimal<S extends ScaleMetrics>

Parameters:

val - value with which the maximum is to be computed.

Returns:

the Decimal whose value is the greater of this Decimal and val. If they are equal, as defined by the compareTo method, this is returned.

See Also:

Decimal.compareTo(Decimal)