com.vaadin.flow.data.converter

Class StringToIntegerConverter

java.lang.Object

com.vaadin.flow.data.converter.AbstractStringToNumberConverter<Integer>

com.vaadin.flow.data.converter.StringToIntegerConverter

All Implemented Interfaces:

Converter<String,Integer>, Serializable

public class StringToIntegerConverter
extends AbstractStringToNumberConverter<Integer>

A converter that converts from String to Integer and back. Uses the given locale and a NumberFormat instance for formatting and parsing.

Override and overwrite getFormat(Locale) to use a different format.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringToIntegerConverter(ErrorMessageProvider errorMessageProvider) Creates a new converter instance with the given error message provider.
StringToIntegerConverter(Integer emptyValue, ErrorMessageProvider errorMessageProvider) Creates a new converter instance with the given presentation value for empty string and error message provider.
StringToIntegerConverter(Integer emptyValue, String errorMessage) Creates a new converter instance with the given presentation value for empty string and error message.
StringToIntegerConverter(String errorMessage) Creates a new converter instance with the given error message.

Method Summary

Modifier and Type	Method and Description
Result<Integer>	convertToModel(String value, ValueContext context) Converts the given value from presentation type to model type.
protected NumberFormat	getFormat(Locale locale) Returns the format used by Converter.convertToPresentation(Object, ValueContext) and convertToModel(String, ValueContext).

Methods inherited from class com.vaadin.flow.data.converter.AbstractStringToNumberConverter

convertToNumber, convertToPresentation, getErrorMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.data.converter.Converter

chain, from, from, identity

Constructor Detail

StringToIntegerConverter

public StringToIntegerConverter(String errorMessage)

Creates a new converter instance with the given error message. Empty strings are converted to null.

Parameters:

errorMessage - the error message to use if conversion fails

StringToIntegerConverter

public StringToIntegerConverter(Integer emptyValue,
                                String errorMessage)

Creates a new converter instance with the given presentation value for empty string and error message.

Parameters:

emptyValue - the presentation value to return when converting an empty string, may be null

errorMessage - the error message to use if conversion fails

StringToIntegerConverter

public StringToIntegerConverter(ErrorMessageProvider errorMessageProvider)

Creates a new converter instance with the given error message provider. Empty strings are converted to null.

Parameters:

errorMessageProvider - the error message provider to use if conversion fails

StringToIntegerConverter

public StringToIntegerConverter(Integer emptyValue,
                                ErrorMessageProvider errorMessageProvider)

Creates a new converter instance with the given presentation value for empty string and error message provider.

Parameters:

emptyValue - the presentation value to return when converting an empty string, may be null

errorMessageProvider - the error message provider to use if conversion fails

Method Detail

getFormat

protected NumberFormat getFormat(Locale locale)

Returns the format used by Converter.convertToPresentation(Object, ValueContext) and convertToModel(String, ValueContext).

Overrides:

getFormat in class AbstractStringToNumberConverter<Integer>

Parameters:

locale - The locale to use

Returns:

A NumberFormat instance

convertToModel

public Result<Integer> convertToModel(String value,
                                      ValueContext context)

Description copied from interface: Converter

Converts the given value from presentation type to model type.

A converter can optionally use locale to do the conversion.

Parameters:

value - The value to convert. Can be null

context - The value context for the conversion.

Returns:

The converted value compatible with the source type