MonetaryOperators (Moneta (JSR 354 RI) 1.1 API)

java.lang.Object
- org.javamoney.moneta.function.MonetaryOperators

```
public final class MonetaryOperators
extends Object
```
This singleton class provides access to the predefined monetary functions.
The class is thread-safe, which is also true for all functions returned by this class.
```
 
 	MonetaryAmount money = Money.parse("EUR 2.35");
  MonetaryAmount result = operator.apply(money);
 
 
```
Or using:
```
 
 	MonetaryAmount money = Money.parse("EUR 2.35");
  MonetaryAmount result = money.with(operator);
 
 
```
Since:

1.0.1

Author:

Anatole Tresch, Otavio Santana

See Also:

MonetaryAmount#with(MonetaryOperator)}, MonetaryOperator}, MonetaryOperator#apply(MonetaryAmount)}

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static javax.money.MonetaryOperator`	`exchangeCurrency(javax.money.CurrencyUnit currencyUnit)` Deprecated.
`static javax.money.MonetaryOperator`	`majorPart()` Extract major part of `MonetaryAmount` This returns the monetary amount in terms of the minor units of the currency, truncating the whole part if necessary.
`static javax.money.MonetaryOperator`	`minorPart()` Extract minor part of `MonetaryAmount` This returns the monetary amount in terms of the minor units of the currency, truncating the whole part if necessary.
`static javax.money.MonetaryOperator`	`percent(BigDecimal decimal)` Gets the percentage of the amount.
`static javax.money.MonetaryOperator`	`percent(Number number)` Gets the percentage of the amount.
`static javax.money.MonetaryOperator`	`permil(BigDecimal decimal)` Gets the permil of the amount.
`static javax.money.MonetaryOperator`	`permil(Number number)` Returns the `percent(BigDecimal)` converting this number to `BigDecimal` and using the `ConversionOperators.DEFAULT_MATH_CONTEXT`
`static javax.money.MonetaryOperator`	`permil(Number number, MathContext mathContext)` Returns the `percent(BigDecimal)` converting this number to `BigDecimal` and using the `MathContext` in parameters
`static javax.money.MonetaryOperator`	`reciprocal()` Gets the reciprocal of `MonetaryAmount` Gets the amount as reciprocal, multiplicative inverse value (1/n).
`static javax.money.MonetaryOperator`	`rounding()` Rounding the `MonetaryAmount` using `CurrencyUnit.getDefaultFractionDigits()` and `RoundingMode.HALF_EVEN`.
`static javax.money.MonetaryOperator`	`rounding(int scale)` Rounding the `MonetaryAmount` using the scale informed and `RoundingMode.HALF_EVEN`.
`static javax.money.MonetaryOperator`	`rounding(RoundingMode roundingMode)` Rounding the `MonetaryAmount` using `CurrencyUnit.getDefaultFractionDigits()` and `RoundingMode`.
`static javax.money.MonetaryOperator`	`rounding(RoundingMode roundingMode, int scale)` Rounding the `MonetaryAmount` using `CurrencyUnit.getDefaultFractionDigits()` and `RoundingMode`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - reciprocal
```
public static javax.money.MonetaryOperator reciprocal()
```
    Gets the reciprocal of MonetaryAmount
    Gets the amount as reciprocal, multiplicative inverse value (1/n).
```
MonetaryAmount money = Money.parse("EUR 2.0");
MonetaryAmount result = ConversionOperators.reciprocal().apply(money);//EUR 0.5
```
    Returns:
    
    the reciprocal part as MonetaryOperator
  - permil
```
public static javax.money.MonetaryOperator permil(BigDecimal decimal)
```
    Gets the permil of the amount.
    This returns the monetary amount in permil. For example, for 10% 'EUR 2.35' will return 0.235.
```
MonetaryAmount money = Money.parse("EUR EUR 2.35");
MonetaryAmount result = ConversionOperators.permil(BigDecimal.TEN).apply(money);//EUR 0.0235
```
    Returns:
    
    the permil as MonetaryOperator
  - permil
```
public static javax.money.MonetaryOperator permil(Number number)
```
    Returns the percent(BigDecimal) converting this number to BigDecimal and using the ConversionOperators.DEFAULT_MATH_CONTEXT
    
    Parameters:
    
    number - to be converted to BigDecimal
    
    Returns:
    
    the permil MonetaryOperator
    
    See Also:
    
    #permil(BigDecimal)}
  - permil
```
public static javax.money.MonetaryOperator permil(Number number,
                                                  MathContext mathContext)
```
    Returns the percent(BigDecimal) converting this number to BigDecimal and using the MathContext in parameters
    
    Parameters:
    
    number - to be converted to BigDecimal
    
    mathContext - the mathContext to be used
    
    Returns:
    
    the permil MonetaryOperator
    
    See Also:
    
    #permil(BigDecimal)}
  - percent
```
public static javax.money.MonetaryOperator percent(BigDecimal decimal)
```
    Gets the percentage of the amount.
    This returns the monetary amount in percent. For example, for 10% 'EUR 2.35' will return 0.235.
```
MonetaryAmount money = Money.parse("EUR 200.0");
MonetaryAmount result = ConversionOperators.percent(BigDecimal.TEN).apply(money);//EUR 20.0
```
    Parameters:
    
    decimal - the value to percent
    
    Returns:
    
    the percent of MonetaryOperator
  - percent
```
public static javax.money.MonetaryOperator percent(Number number)
```
    Gets the percentage of the amount.
    
    Parameters:
    
    number - to be used in percent
    
    Returns:
    
    the percent of MonetaryOperator
    
    See Also:
    
    #percent(BigDecimal)}
  - minorPart
```
public static javax.money.MonetaryOperator minorPart()
```
    Extract minor part of MonetaryAmount
    This returns the monetary amount in terms of the minor units of the currency, truncating the whole part if necessary. For example, 'EUR 2.35' will return 'EUR 0.35', and 'BHD -1.345' will return 'BHD -0.345'.
```
MonetaryAmount money = Money.parse("EUR 2.35");
MonetaryAmount result = ConversionOperators.minorPart().apply(money);//EUR 0.35
```
    Returns:
    
    the minor part as MonetaryOperator
  - majorPart
```
public static javax.money.MonetaryOperator majorPart()
```
    Extract major part of MonetaryAmount
    This returns the monetary amount in terms of the minor units of the currency, truncating the whole part if necessary. For example, 'EUR 2.35' will return 'EUR 0.35', and 'BHD -1.345' will return 'BHD -0.345'.
```
MonetaryAmount money = Money.parse("EUR 2.35");
MonetaryAmount result = ConversionOperators.majorPart().apply(money);//EUR 2.0
```
    Returns:
    
    the major part as MonetaryOperator
  - rounding
```
public static javax.money.MonetaryOperator rounding()
```
    Rounding the MonetaryAmount using CurrencyUnit.getDefaultFractionDigits() and RoundingMode.HALF_EVEN.
    For example, 'EUR 2.3523' will return 'EUR 2.35', and 'BHD -1.34534432' will return 'BHD -1.345'.
```
MonetaryAmount money = Money.parse("EUR 2.355432");
MonetaryAmount result = ConversionOperators.rounding().apply(money);//EUR 2.36
```
    Returns:
    
    the major part as MonetaryOperator
  - rounding
```
public static javax.money.MonetaryOperator rounding(RoundingMode roundingMode)
```
    Rounding the MonetaryAmount using CurrencyUnit.getDefaultFractionDigits() and RoundingMode.
    For example, 'EUR 2.3523' will return 'EUR 2.35', and 'BHD -1.34534432' will return 'BHD -1.345'.
```
MonetaryAmount money = Money.parse("EUR 2.355432");
MonetaryAmount result = ConversionOperators.rounding(RoundingMode.HALF_EVEN).apply(money);//EUR 2.35
```
    Parameters:
    
    roundingMode - rounding to be used
    
    Returns:
    
    the major part as MonetaryOperator
  - rounding
```
public static javax.money.MonetaryOperator rounding(RoundingMode roundingMode,
                                                    int scale)
```
    Rounding the MonetaryAmount using CurrencyUnit.getDefaultFractionDigits() and RoundingMode.
    For example, 'EUR 2.3523' will return 'EUR 2.35', and 'BHD -1.34534432' will return 'BHD -1.345'.
```
MonetaryAmount money = Money.parse("EUR 2.355432");
MonetaryAmount result = ConversionOperators.rounding(RoundingMode.HALF_EVEN, 3).apply(money);//EUR 2.352
```
    Parameters:
    
    roundingMode - rounding to be used
    
    scale - to be used
    
    Returns:
    
    the major part as MonetaryOperator
  - rounding
```
public static javax.money.MonetaryOperator rounding(int scale)
```
    Rounding the MonetaryAmount using the scale informed and RoundingMode.HALF_EVEN.
    For example, 'EUR 2.3523' will return 'EUR 2.35', and 'BHD -1.34534432' will return 'BHD -1.345'.
```
MonetaryAmount money = Money.parse("EUR 2.355432");
MonetaryAmount result = ConversionOperators.rounding(2).apply(money);//EUR 2.35
```
    Parameters:
    
    scale - scale to be used
    
    Returns:
    
    the major part as MonetaryOperator
  - exchangeCurrency
```
@Deprecated
public static javax.money.MonetaryOperator exchangeCurrency(javax.money.CurrencyUnit currencyUnit)
```
    Deprecated.
    Do exchange of currency, in other words, create the monetary amount with the same value but with currency different.
    For example, 'EUR 2.35', using the currency 'USD' as exchange parameter, will return 'USD 2.35', and 'BHD -1.345', using the currency 'USD' as exchange parameter, will return 'BHD -1.345'.
```
Currency real = Monetary.getCurrency("BRL");
MonetaryAmount money = Money.parse("EUR 2.355");
MonetaryAmount result = MonetaryOperators.exchangeCurrency(real).apply(money);//BRL 2.355
```
    Parameters:
    
    currencyUnit - currency to be used
    
    Returns:
    
    the major part as MonetaryOperator

Class MonetaryOperators

Method Summary

Methods inherited from class java.lang.Object

Method Detail

reciprocal

permil

permil

permil

percent

percent

minorPart

majorPart

rounding

rounding

rounding

rounding

exchangeCurrency