org.decimal4j.exact

Class Multipliable18f

java.lang.Object

org.decimal4j.exact.Multipliable18f

public final class Multipliable18f
extends Object

A Multipliable18f encapsulates a Decimal of scale 18 and facilitates exact typed multiplication. The multipliable object acts as first factor in the multiplication and provides a set of overloaded methods for different scales. Each one of those methods delivers a different result scale which represents the appropriate scale for the product of an exact multiplication.

A Multipliable18f object is returned by Decimal18f.multiplyExact(), hence an exact typed multiplication can be written as:

 Decimal18f value = ... //some value
 Decimal18f product = value.multiplyExact().by(Decimal0f.FIVE);
 

Constructor Summary

Constructors

Constructor and Description
Multipliable18f(Decimal<Scale18f> value) Constructor with Decimal value to be encapsulated.

Method Summary

Methods

Modifier and Type	Method and Description
Decimal18f	by(Decimal0f factor) Returns a Decimal whose value is (this * factor).
Decimal18f	by(MutableDecimal0f factor) Returns a Decimal whose value is (this * factor).
boolean	equals(Object obj) Compares this Multipliable18f to the specified object.
Decimal<Scale18f>	getValue() Returns the value underlying this Multipliable18f.
int	hashCode() Returns a hash code for this Multipliable18f which happens to be the hash code of the underlying Decimal18f value.
String	toString() Returns a string representation of this Multipliable18f which is simply the string representation of the underlying Decimal value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Multipliable18f

public Multipliable18f(Decimal<Scale18f> value)

Constructor with Decimal value to be encapsulated.

Parameters:

value - the decimal value to be wrapped as a multipliable object

Method Detail

getValue

public Decimal<Scale18f> getValue()

Returns the value underlying this Multipliable18f.

Returns:

the Decimal value wrapped by this multipliable object

by

public Decimal18f by(Decimal0f factor)

Returns a Decimal whose value is (this * factor). The result is exact and has scale 18 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal18f.

Note that the result is always a new instance.

Parameters:

factor - the factor to multiply with the Decimal that this multipliable represents

Returns:

(this * factor)

Throws:

ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal18f

by

public Decimal18f by(MutableDecimal0f factor)

Returns a Decimal whose value is (this * factor). The result is exact and has scale 18 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal18f.

Note that the result is always a new instance.

Parameters:

factor - the factor to multiply with the Decimal that this multipliable represents

Returns:

(this * factor)

Throws:

ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal18f

hashCode

public int hashCode()

Returns a hash code for this Multipliable18f which happens to be the hash code of the underlying Decimal18f value.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object

See Also:

Decimal.hashCode()

equals

public boolean equals(Object obj)

Compares this Multipliable18f to the specified object. The result is true if and only if the argument is a Multipliable18f with an equal underlying value.

Overrides:

equals in class Object

Parameters:

obj - the object to compare with

Returns:

true if the argument is a Multipliable18f and if its value is equal to this multipliables's value; false otherwise

See Also:

getValue(), Decimal.equals(Object)

toString

public String toString()

Returns a string representation of this Multipliable18f which is simply the string representation of the underlying Decimal value.

Overrides:

toString in class Object

Returns:

a String Decimal representation of this Multipliable18f's value with all the fraction digits (including trailing zeros)

See Also:

getValue(), Decimal.toString()