org.decimal4j.generic

Class GenericImmutableDecimal<S extends ScaleMetrics>

java.lang.Object

java.lang.Number

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

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

org.decimal4j.generic.GenericImmutableDecimal<S>

Type Parameters:

S - the scale metrics type associated with this decimal

All Implemented Interfaces:

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

public final class GenericImmutableDecimal<S extends ScaleMetrics>
extends AbstractImmutableDecimal<S,GenericImmutableDecimal<S>>

GenericImmutableDecimal is an ImmutableDecimal implemented in a generic way, that is, different instances can have different scales. In contrast the classes defined in the immutable package have have no generic parameter as they have a fixed scale per class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenericImmutableDecimal(Decimal<S> decimal) Creates a new GenericImmutableDecimal with the same value and scale as the given decimal argument.
GenericImmutableDecimal(S scaleMetrics, long unscaledValue) Creates a new GenericImmutableDecimal with the scale specified by the given scaleMetrics argument.

Method Summary

Methods

Modifier and Type	Method and Description
protected GenericImmutableDecimal<S>	create(long unscaled) Returns a new Decimal whose value is (unscaled × 10-scale).
protected GenericImmutableDecimal<S>[]	createArray(int length) Returns a new Decimal array of the specified length.
protected GenericImmutableDecimal<S>	createOrAssign(long unscaled) Returns this or a new Decimal whose value is (unscaled × 10-scale).
GenericDecimalFactory<S>	getFactory() Returns the factory that can be used to create other Decimal values of the same scale as this Decimal.
int	getScale() Returns the scale associated with this Decimal.
S	getScaleMetrics() Returns the metrics associated with the scale of this Decimal.
protected GenericImmutableDecimal<S>	self() Returns this decimal value as concrete implementation subtype.
GenericImmutableDecimal<S>	toImmutableDecimal() If this Decimal value is already an ImmutableDecimal it is simply returned.
GenericMutableDecimal<S>	toMutableDecimal() If this Decimal value is already a MutableDecimal it is simply returned.
static <S extends ScaleMetrics> GenericImmutableDecimal<S>	valueOf(Decimal<S> decimal) Creates and returns a new GenericImmutableDecimal with the same value and scale as the given decimal argument.
static GenericImmutableDecimal<?>	valueOfUnscaled(int scale, long unscaled) Creates and returns a new GenericImmutableDecimal with the specified scale and value.
static <S extends ScaleMetrics> GenericImmutableDecimal<S>	valueOfUnscaled(S scaleMetrics, long unscaled) Creates and returns a new GenericImmutableDecimal with the scale specified by the given scaleMetrics argument.

Methods inherited from class org.decimal4j.base.AbstractImmutableDecimal

max, min, multiplyExact, scale, scale, scale, scale, toString, unscaledValue

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, 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, 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

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, 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

Constructor Detail

GenericImmutableDecimal

public GenericImmutableDecimal(S scaleMetrics,
                       long unscaledValue)

Creates a new GenericImmutableDecimal with the scale specified by the given scaleMetrics argument. The numeric value of new the Decimal is unscaledValue × 10-scale

Parameters:

scaleMetrics - the metrics object defining the scale for the new value

unscaledValue - the unscaled long value representing the new Decimal's numerical value before applying the scale factor

GenericImmutableDecimal

public GenericImmutableDecimal(Decimal<S> decimal)

Creates a new GenericImmutableDecimal with the same value and scale as the given decimal argument.

Parameters:

decimal - the numeric value to assign to the created immutable Decimal

Method Detail

valueOf

public static <S extends ScaleMetrics> GenericImmutableDecimal<S> valueOf(Decimal<S> decimal)

Creates and returns a new GenericImmutableDecimal with the same value and scale as the given decimal argument.

Type Parameters:

S - the scale metrics type

Parameters:

decimal - the numeric value to assign to the created immutable Decimal

Returns:

a new generic immutable Decimal value with scale and value copied from the decimal argument

valueOfUnscaled

public static <S extends ScaleMetrics> GenericImmutableDecimal<S> valueOfUnscaled(S scaleMetrics,
                                                                  long unscaled)

Creates and returns a new GenericImmutableDecimal with the scale specified by the given scaleMetrics argument. The numeric value of new the Decimal is unscaledValue × 10-scale

Type Parameters:

S - the scale metrics type

Parameters:

scaleMetrics - the metrics object defining the scale for the new value

unscaled - the unscaled long value representing the new Decimal's numerical value before applying the scale factor

Returns:

a new Decimal value representing unscaledValue × 10-scale

valueOfUnscaled

public static GenericImmutableDecimal<?> valueOfUnscaled(int scale,
                                         long unscaled)

Creates and returns a new GenericImmutableDecimal with the specified scale and value. The numeric value of new the Decimal is unscaledValue × 10-scale

Parameters:

scale - the scale for the new value

unscaled - the unscaled long value representing the new Decimal's numerical value before applying the scale factor

Returns:

a new Decimal value representing unscaledValue × 10-scale

getScaleMetrics

public S getScaleMetrics()

Description copied from interface: Decimal

Returns the metrics associated with the scale of this Decimal. Scale defines the number of fraction digits and the scale factor applied to the long value underlying this Decimal.

Returns:

the scale metrics object

See Also:

ScaleMetrics.getScale(), ScaleMetrics.getScaleFactor()

getScale

public int getScale()

Description copied from interface: Decimal

Returns the scale associated with this Decimal. The scale defines the number of fraction digits and the scale factor applied to the long value underlying this Decimal.

If the scale is f then the value represented by a Decimal instance is (unscaledValue × 10^-f).

This method is a shortcut for getScaleMetrics().getScale().

Returns:

the scale

See Also:

Decimal.getScaleMetrics(), ScaleMetrics.getScale(), Decimal.unscaledValue()

getFactory

public GenericDecimalFactory<S> getFactory()

Description copied from interface: Decimal

Returns the factory that can be used to create other Decimal values of the same scale as this Decimal.

Returns:

the factory to create other Decimal values of the same scale as this Decimal

self

protected GenericImmutableDecimal<S> self()

Description copied from class: AbstractDecimal

Returns this decimal value as concrete implementation subtype.

Specified by:

self in class AbstractDecimal<S extends ScaleMetrics,GenericImmutableDecimal<S extends ScaleMetrics>>

Returns:

this

createOrAssign

protected GenericImmutableDecimal<S> createOrAssign(long unscaled)

Description copied from class: AbstractDecimal

Returns this or a new Decimal whose value is (unscaled × 10^-scale).

The returned value is a new instance if this decimal is an ImmutableDecimal. If it is a MutableDecimal then its internal state is altered and this is returned as result now representing (unscaled × 10^-scale).

Specified by:

createOrAssign in class AbstractDecimal<S extends ScaleMetrics,GenericImmutableDecimal<S extends ScaleMetrics>>

Parameters:

unscaled - unscaled value to be returned as a Decimal

Returns:

unscaled × 10^-scale

create

protected GenericImmutableDecimal<S> create(long unscaled)

Description copied from class: AbstractDecimal

Returns a new Decimal whose value is (unscaled × 10^-scale).

Specified by:

create in class AbstractDecimal<S extends ScaleMetrics,GenericImmutableDecimal<S extends ScaleMetrics>>

Parameters:

unscaled - unscaled value to be returned as a Decimal

Returns:

unscaled × 10^-scale

createArray

protected GenericImmutableDecimal<S>[] createArray(int length)

Description copied from class: AbstractDecimal

Returns a new Decimal array of the specified length.

Specified by:

createArray in class AbstractDecimal<S extends ScaleMetrics,GenericImmutableDecimal<S extends ScaleMetrics>>

Parameters:

length - the length of the array to return

Returns:

new D[length]

toMutableDecimal

public GenericMutableDecimal<S> toMutableDecimal()

Description copied from interface: Decimal

If this Decimal value is already a MutableDecimal it is simply returned. Otherwise a new mutable value with the same scale and numerical value as this Decimal is created and returned.

Returns:

this if mutable and a new MutableDecimal with the same scale and value as this Decimal otherwise

toImmutableDecimal

public GenericImmutableDecimal<S> toImmutableDecimal()

Description copied from interface: Decimal

If this Decimal value is already an ImmutableDecimal it is simply returned. Otherwise a new immutable value with the same scale and numerical value as this Decimal is created and returned.

Returns:

this if immutable and a new ImmutableDecimal with the same scale and value as this Decimal otherwise