org.javamoney.moneta.function

Class ScaleRoundedOperator

java.lang.Object

org.javamoney.moneta.function.ScaleRoundedOperator

All Implemented Interfaces:

MonetaryOperator

public final class ScaleRoundedOperator
extends Object
implements MonetaryOperator

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

   

     MonetaryOperator monetaryOperator = ScaleRoundedOperator.of(scale, RoundingMode.HALF_EVEN);
     CurrencyUnit real = Monetary.getCurrency("BRL");
     MonetaryAmount money = Money.of(BigDecimal.valueOf(35.34567), real);
     MonetaryAmount result = monetaryOperator.apply(money); // BRL 35.3457

    
 

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

Author:

Otavio Santana

See Also:

ScaleRoundedOperator(int, RoundingMode), RoundedMoney, MonetaryOperator, BigDecimal.scale()

Method Summary

Modifier and Type	Method and Description
MonetaryAmount	apply(MonetaryAmount amount)
RoundingMode	getRoundingMode()
int	getScale()
static ScaleRoundedOperator	of(int scale, RoundingMode roundingMode) 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 ScaleRoundedOperator of(int scale,
                                      RoundingMode roundingMode)

Creates the rounded Operator from scale and roundingMode

Parameters:

scale - the scale to be used

roundingMode - the rounding mode to be used

Returns:

the MonetaryOperator using the scale and RoundingMode used in parameter

Throws:

NullPointerException - when the MathContext is null

See Also:

RoundingMode

apply

public MonetaryAmount apply(MonetaryAmount amount)

Specified by:

apply in interface MonetaryOperator

getScale

public int getScale()

getRoundingMode

public RoundingMode getRoundingMode()

toString

public String toString()

Overrides:

toString in class Object