com.vaadin.data.converter.StringToBigDecimalConverter Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.data.converter;
import java.math.BigDecimal;
import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.util.Locale;
import com.vaadin.data.ErrorMessageProvider;
import com.vaadin.data.Result;
import com.vaadin.data.ValueContext;
/**
* A converter that converts from {@link String} to {@link BigDecimal} and back.
* Uses the given locale and a {@link NumberFormat} instance for formatting and
* parsing.
*
* Leading and trailing white spaces are ignored when converting from a String.
*
*
* Override and overwrite {@link #getFormat(Locale)} to use a different format.
*
*
* @author Vaadin Ltd
* @since 8.0
*/
public class StringToBigDecimalConverter
extends AbstractStringToNumberConverter {
/**
* Creates a new converter instance with the given error message. Empty
* strings are converted to null.
*
* @param errorMessage
* the error message to use if conversion fails
*/
public StringToBigDecimalConverter(String errorMessage) {
this(null, errorMessage);
}
/**
* Creates a new converter instance with the given empty string value and
* error message.
*
* @param emptyValue
* the presentation value to return when converting an empty
* string, may be null
* @param errorMessage
* the error message to use if conversion fails
*/
public StringToBigDecimalConverter(BigDecimal emptyValue,
String errorMessage) {
super(emptyValue, errorMessage);
}
/**
* Creates a new converter instance with the given error message provider.
* Empty strings are converted to null.
*
* @param errorMessageProvider
* the error message provider to use if conversion fails
*
* @since 8.4
*/
public StringToBigDecimalConverter(
ErrorMessageProvider errorMessageProvider) {
this(null, errorMessageProvider);
}
/**
* Creates a new converter instance with the given empty string value and
* error message provider.
*
* @param emptyValue
* the presentation value to return when converting an empty
* string, may be null
* @param errorMessageProvider
* the error message provider to use if conversion fails
*
* @since 8.4
*/
public StringToBigDecimalConverter(BigDecimal emptyValue,
ErrorMessageProvider errorMessageProvider) {
super(emptyValue, errorMessageProvider);
}
@Override
protected NumberFormat getFormat(Locale locale) {
NumberFormat numberFormat = super.getFormat(locale);
if (numberFormat instanceof DecimalFormat) {
((DecimalFormat) numberFormat).setParseBigDecimal(true);
}
return numberFormat;
}
@Override
public Result convertToModel(String value,
ValueContext context) {
return convertToNumber(value, context)
.map(number -> (BigDecimal) number);
}
}