org.javamoney.moneta.function

Class PrecisionScaleRoundedOperator

java.lang.Object

org.javamoney.moneta.function.PrecisionScaleRoundedOperator

All Implemented Interfaces:

MonetaryOperator

public final class PrecisionScaleRoundedOperator
extends Object
implements MonetaryOperator

This implementation uses a scale and RoundingMode and precision to does the rounding operations. The implementation will use both the scale and precision, in other words, the number of digits to the right of the decimal point and the number of digits. The derived class will implements the RoundedMoney with this rounding monetary operator

   
     int scale = 3;
     int precision = 5;
     MathContext mathContext = new MathContext(precision, RoundingMode.HALF_EVEN);
     MonetaryOperator monetaryOperator = PrecisionScaleRoundedOperator.of(scale, mathContext);
     CurrencyUnit real = Monetary.getCurrency("BRL");
     MonetaryAmount money = Money.of(BigDecimal.valueOf(35.34567), real);
     MonetaryAmount result = monetaryOperator.apply(money); // BRL 35.346

    
 

Case the parameter in MonetaryOperator.apply(MonetaryAmount) be null, the apply will return a NullPointerException

Author:

Otavio Santana

See Also:

RoundedMoney, MonetaryOperator, BigDecimal.scale(), MathContext, BigDecimal.precision()

Method Summary

Modifier and Type	Method and Description
MonetaryAmount	apply(MonetaryAmount amount)
MathContext	getMathContext()
int	getScale()
static PrecisionScaleRoundedOperator	of(int scale, MathContext mathContext) Creates the rounded Operator from scale and roundingMode
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static PrecisionScaleRoundedOperator of(int scale,
                                               MathContext mathContext)

Creates the rounded Operator from scale and roundingMode

Parameters:

mathContext - the math context, not null.

Returns:

the MonetaryOperator using the scale and RoundingMode used in parameter

Throws:

NullPointerException - when the MathContext is null

IllegalArgumentException - if MathContext.getPrecision() is lesser than zero

IllegalArgumentException - if MathContext.getRoundingMode() is RoundingMode.UNNECESSARY

See Also:

RoundingMode

apply

public MonetaryAmount apply(MonetaryAmount amount)

Specified by:

apply in interface MonetaryOperator

getScale

public int getScale()

getMathContext

public MathContext getMathContext()

toString

public String toString()

Overrides:

toString in class Object