com.vaadin.data.converter.StringToIntegerConverter 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.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 Integer} and back.
* Uses the given locale and a {@link NumberFormat} instance for formatting and
* parsing.
*
* Override and overwrite {@link #getFormat(Locale)} to use a different format.
*
*
* @author Vaadin Ltd
* @since 8.0
*/
public class StringToIntegerConverter
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 StringToIntegerConverter(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 StringToIntegerConverter(Integer 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 StringToIntegerConverter(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 StringToIntegerConverter(Integer emptyValue,
ErrorMessageProvider errorMessageProvider) {
super(emptyValue, errorMessageProvider);
}
/**
* Returns the format used by
* {@link #convertToPresentation(Object, ValueContext)} and
* {@link #convertToModel(String, ValueContext)}.
*
* @param locale
* The locale to use
* @return A NumberFormat instance
*/
@Override
protected NumberFormat getFormat(Locale locale) {
if (locale == null) {
locale = Locale.getDefault();
}
return NumberFormat.getIntegerInstance(locale);
}
@Override
public Result convertToModel(String value, ValueContext context) {
Result n = convertToNumber(value, context);
return n.flatMap(number -> {
if (number == null) {
return Result.ok(null);
}
int intValue = number.intValue();
if (intValue == number.longValue()) {
// If the value of n is outside the range of long, the
// return value of longValue() is either Long.MIN_VALUE or
// Long.MAX_VALUE. The/ above comparison promotes int to
// long and thus does not need to consider wrap-around.
return Result.ok(intValue);
}
return Result.error(getErrorMessage(context));
});
}
}