MoneyUtil (domui :: domui-core 1.1 API)

java.lang.Object
- to.etc.domui.converter.MoneyUtil

```
public class MoneyUtil
extends Object
```
Utility class to handle all kinds of monetary value presentation and conversion. This parses a monetary amount entered in a string in a very lax way, to allow for maximal ease of use in entering currency amounts. It obeys most of the rules for european (euro) amounts but has a few specials:
- Any leading currency sign (euro sign) is skipped. Only the euro sign is allowed before the amount!
- The dot and comma can both be used as either decimal point and thousands separator. If you use the one as decimal point then the other, when present, must represent the thousands separator and it is only allowed at the correct positions in the number.
- If a decimal point (comma or dot) is present it can be followed by no digits, one digit like .5 which will be translated as .50 or two digits. Anything else is an error.
- If thousands separators are present they must be fully valid, meaning if one exists all others must exist too, and all of them must be present at the correct location in the string.
Author:

Frits Jalvingh Created on Jul 29, 2009

Constructor Summary

Constructors
Constructor and Description

MoneyUtil()

Constructors
Constructor and Description
`MoneyUtil()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`areRoundedValuesEqual(BigDecimal value1, BigDecimal value2)`
`static boolean`	`areRoundedValuesEqual(double value1, double value2)` This operation compares two double values for equality.
`static <T> void`	`assignMonetaryConverter(PropertyMetaModel<T> pmm, boolean editable, IConvertable<T> node)`
`static int`	`getMoneyScale()` Use this method for money amount rounding purposes.
`static RoundingMode`	`getRoundingMode()` Use this method for money amount rounding purposes.
`static boolean`	`isRoundedAsZero(BigDecimal value)` Checks if specified amount is zero value, when built-in rounding mode and scale are applied.
`static void`	`main(String[] args)`
`static BigDecimal`	`parseEuroToBigDecimal(String input)` Parse into a BigDecimal, return null for empty input.
`static BigDecimal`	`parseEuroToBigDecimal(String input, int scale, boolean useStrictScale)` Parse into a BigDecimal, return null for empty input.
`static Double`	`parseEuroToDoubleW(String input)` Deprecated.
`static Double`	`parseEuroToDoubleW(String input, int scale, boolean useStrictScale)` Deprecated.
`static <T> T`	`parseMoney(Class<T> valueClass, String in)` Parse a monetary value and return the proper value type, either Double or BigDecimal.
`static String`	`render(BigDecimal v, boolean thousands, boolean symbol, boolean trunk)` Convert the BigDecimal to a formatted monetary value.
`static String`	`render(double v, boolean thousands, boolean symbol, boolean trunk)` Deprecated.
`static String`	`renderAsSimpleDotted(double v)` Deprecated.
`static String`	`renderFullWithSign(BigDecimal v)` Render as a full value: [C -###,###,###.00], including currency sign, thousands separator and all, using the specified currency locale.
`static String`	`renderFullWithSign(double v)` Deprecated.
`static String`	`renderTruncatedWithSign(BigDecimal v)` Renders as a full value [C -###,###,###.##], but removes the fraction if it is all zeroes.
`static String`	`renderTruncatedWithSign(double v)` Deprecated.
`static BigDecimal`	`roundValue(BigDecimal value)`
`static double`	`roundValue(double value)` Deprecated.

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

- Constructor Detail
  - MoneyUtil
```
public MoneyUtil()
```
- Method Detail
  - parseMoney
```
public static <T> T parseMoney(Class<T> valueClass,
                               String in)
```
    Parse a monetary value and return the proper value type, either Double or BigDecimal. FIXME Localization failure.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    valueClass -
    
    in -
    
    Returns:
  - getMoneyScale
```
public static int getMoneyScale()
```
    Use this method for money amount rounding purposes.
    
    Returns:
    
    Returns used maximum fraction digits value.
  - getRoundingMode
```
public static RoundingMode getRoundingMode()
```
    Use this method for money amount rounding purposes.
    
    Returns:
    
    rounding mode to use for currency.
  - parseEuroToDoubleW
```
@Deprecated
public static Double parseEuroToDoubleW(String input)
```
    Deprecated.
    
    Deprecated - do not use double for monetary amounts - Parse into a double; return null for empty input. FIXME Localization failure!
    
    Parameters:
    
    input -
    
    Returns:
  - parseEuroToDoubleW
```
@Deprecated
public static Double parseEuroToDoubleW(String input,
                                                    int scale,
                                                    boolean useStrictScale)
```
    Deprecated.
    
    Deprecated - do not use double for monetary amounts - Parse into a double; return null for empty input. FIXME Localization failure!
    
    Parameters:
    
    input -
    
    scale - in use
    
    useStrictScale - in case of T, if input does not have strict number (defined by scale) of decimal digits after decimal point, it would be rejected as invalid value.
    
    Returns:
  - parseEuroToBigDecimal
```
public static BigDecimal parseEuroToBigDecimal(String input)
```
    Parse into a BigDecimal, return null for empty input.
    
    Parameters:
    
    input -
    
    Returns:
  - parseEuroToBigDecimal
```
public static BigDecimal parseEuroToBigDecimal(String input,
                                               int scale,
                                               boolean useStrictScale)
```
    Parse into a BigDecimal, return null for empty input.
    
    Parameters:
    
    input -
    
    scale -
    
    useStrictScale - in case of T, if input does not have strict number (defined by scale) of decimal digits after decimal point, it would be rejected as invalid value.
    
    Returns:
  - renderAsSimpleDotted
```
@Deprecated
public static String renderAsSimpleDotted(double v)
```
    Deprecated.
    
    FIXME jal 20091221 This cannot be here- currency precision is dependent on the currency used AND the function it is used in (rounding depends on where you are rounding). Renders the value as a simple amount with the dot as a decimal point and always followed by 2 digits after the dot, rounded even (0.005 = +.01).
    
    Parameters:
    
    v -
    
    Returns:
  - render
```
@Deprecated
public static String render(double v,
                                        boolean thousands,
                                        boolean symbol,
                                        boolean trunk)
```
    Deprecated.
    
    Deprecated - do not use double for monetary amounts.
    
    Parameters:
    
    v -
    
    thousands -
    
    symbol -
    
    trunk -
    
    Returns:
  - render
```
public static String render(BigDecimal v,
                            boolean thousands,
                            boolean symbol,
                            boolean trunk)
```
    Convert the BigDecimal to a formatted monetary value.
    
    Parameters:
    
    v -
    
    thousands - Render thousand separators where needed
    
    symbol - Render the currency sign
    
    trunk - If the fraction is all zeroes, remove the fraction.
    
    Returns:
  - renderFullWithSign
```
@Deprecated
public static String renderFullWithSign(double v)
```
    Deprecated.
    
    Deprecated - do not use double for monetary amounts - Render as a full value: [C -###,###,###.00], including currency sign, thousands separator and all, using the specified currency locale. It always renders the fraction. formatters suck.
    
    Parameters:
    
    v -
    
    Returns:
  - renderFullWithSign
```
public static String renderFullWithSign(BigDecimal v)
```
    Render as a full value: [C -###,###,###.00], including currency sign, thousands separator and all, using the specified currency locale. It always renders the fraction. formatters suck.
    
    Parameters:
    
    v -
    
    Returns:
  - renderTruncatedWithSign
```
@Deprecated
public static String renderTruncatedWithSign(double v)
```
    Deprecated.
    
    Deprecated - do not use double for monetary amounts - Renders as a full value [C -###,###,###.##], but removes the fraction if it is all zeroes.
    
    Parameters:
    
    v -
    
    Returns:
  - renderTruncatedWithSign
```
public static String renderTruncatedWithSign(BigDecimal v)
```
    Renders as a full value [C -###,###,###.##], but removes the fraction if it is all zeroes.
    
    Parameters:
    
    v -
    
    Returns:
  - main
```
public static void main(String[] args)
```
  - roundValue
```
@Deprecated
public static double roundValue(double value)
```
    Deprecated.
    
    Deprecated - do not use double for monetary amounts.
    
    Parameters:
    
    value -
    
    Returns:
  - roundValue
```
@Nonnull
public static BigDecimal roundValue(@Nonnull
                                             BigDecimal value)
```
  - areRoundedValuesEqual
```
public static boolean areRoundedValuesEqual(double value1,
                                            double value2)
```
    This operation compares two double values for equality. Because floating point calculations may involve rounding, calculated double values may not be accurate, so we need to compare with certain tolerance. Since we are using rounding of monetary calculations with predefined precisions, we reuse same tolerance here, so both specified double values are compared as rounded monetary values.
    
    Parameters:
    
    value1 -
    
    value2 -
    
    Returns:
  - areRoundedValuesEqual
```
public static boolean areRoundedValuesEqual(@Nonnull
                                            BigDecimal value1,
                                            @Nonnull
                                            BigDecimal value2)
```
  - isRoundedAsZero
```
public static boolean isRoundedAsZero(@Nonnull
                                      BigDecimal value)
```
    Checks if specified amount is zero value, when built-in rounding mode and scale are applied.
    
    Parameters:
    
    value -
    
    Returns:
  - assignMonetaryConverter
```
public static <T> void assignMonetaryConverter(PropertyMetaModel<T> pmm,
                                               boolean editable,
                                               IConvertable<T> node)
```

Class MoneyUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MoneyUtil

Method Detail

parseMoney

getMoneyScale

getRoundingMode

parseEuroToDoubleW

parseEuroToDoubleW

parseEuroToBigDecimal

parseEuroToBigDecimal

renderAsSimpleDotted

render

render

renderFullWithSign

renderFullWithSign

renderTruncatedWithSign

renderTruncatedWithSign

main

roundValue

roundValue

areRoundedValuesEqual

areRoundedValuesEqual

isRoundedAsZero

assignMonetaryConverter