org.primefaces.util.CurrencyValidator Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright (c) 2009-2023 PrimeTek Informatics
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.primefaces.util;
import java.text.DecimalFormat;
import java.math.BigDecimal;
import java.util.Locale;
/**
*
* Currency Validation and Conversion routines (java.math.BigDecimal).
*
*
* This is one implementation of a currency validator that has the following features:
*
*
* - It is lenient about the presence of the currency symbol
* - It converts the currency to a
java.math.BigDecimal
*
* Modified from Commons Validator to fit PF needs
* @see Commons Validator
*/
public class CurrencyValidator extends BigDecimalValidator {
/** DecimalFormat's currency symbol */
public static final char CURRENCY_SYMBOL = '\u00A4';
public static final String CURRENCY_SYMBOL_STR = Character.toString(CURRENCY_SYMBOL);
private static final long serialVersionUID = -4201640771171486514L;
private static final CurrencyValidator VALIDATOR = new CurrencyValidator();
/**
* Return a singleton instance of this validator.
*
* @return A singleton instance of the CurrencyValidator.
*/
public static CurrencyValidator getInstance() {
return VALIDATOR;
}
/**
*
* Validate/convert a BigDecimal using the specified Locale.
*
* @param value The value validation is being performed on.
* @param locale The locale to use for the number format, system default if null.
* @return The parsed BigDecimal if valid or null if invalid.
*/
public BigDecimal validate(String value, Locale locale) {
return (BigDecimal) parse(value, locale);
}
/**
*
* Returns a String representing the Excel pattern for this currency.
*
*
* @param locale The locale a NumberFormat is required for, system default if null.
* @return The String pattern for using in Excel format.
*/
public String getExcelPattern(Locale locale) {
DecimalFormat format = (DecimalFormat) DecimalFormat.getCurrencyInstance(locale);
String pattern = format.toLocalizedPattern();
pattern = pattern.replace(CURRENCY_SYMBOL_STR, "\"" + format.getDecimalFormatSymbols().getCurrencySymbol() + "\"");
String[] patterns = pattern.split(";");
return patterns[0];
}
/**
*
* Parse the value using the specified pattern.
*
*
* @param value The value validation is being performed on.
* @param locale The locale to use for the date format, system default if null.
* @return The parsed value if valid or null if invalid.
*/
protected Object parse(String value, Locale locale) {
value = (value == null ? null : value.trim());
if (value == null || value.isEmpty()) {
return null;
}
DecimalFormat formatter = getFormat(locale);
return parse(value, formatter);
}
/**
*
* Returns a NumberFormat for the specified Locale.
*
*
* @param locale The locale a NumberFormat is required for, system default if null.
* @return The NumberFormat to created.
*/
public DecimalFormat getFormat(Locale locale) {
return (DecimalFormat) DecimalFormat.getCurrencyInstance(locale);
}
/**
*
* Parse the value with the specified Format.
*
*
* This implementation is lenient whether the currency symbol is present or not. The default NumberFormat behavior is for the parsing to "fail"
* if the currency symbol is missing. This method re-parses with a format without the currency symbol if it fails initially.
*
*
* @param value The value to be parsed.
* @param formatter The Format to parse the value with.
* @return The parsed value if valid or null if invalid.
*/
@Override
protected Number parse(String value, DecimalFormat formatter) {
// check and replace currency symbol
if (value.indexOf(CURRENCY_SYMBOL) >= 0) {
value = value.replace(CURRENCY_SYMBOL_STR, formatter.getDecimalFormatSymbols().getCurrencySymbol());
}
// between JDK8 and 11 some space characters became non breaking space '\u00A0'
if (formatter.getPositivePrefix().indexOf(Constants.NON_BREAKING_SPACE) >= 0) {
value = value.replaceAll(Constants.SPACE, Constants.NON_BREAKING_SPACE_STR);
}
// Initial parse of the value
Number parsedValue = super.parse(value, formatter);
if (parsedValue != null) {
return parsedValue;
}
// Re-parse using a pattern without the currency symbol
String pattern = formatter.toPattern();
if (pattern.indexOf(CURRENCY_SYMBOL) >= 0) {
StringBuilder buffer = new StringBuilder(pattern.length());
for (int i = 0; i < pattern.length(); i++) {
if (pattern.charAt(i) != CURRENCY_SYMBOL) {
buffer.append(pattern.charAt(i));
}
}
DecimalFormat copyFormatter = (DecimalFormat) formatter.clone();
copyFormatter.applyPattern(buffer.toString());
parsedValue = super.parse(value, copyFormatter);
}
return parsedValue;
}
}