com.vaadin.data.util.converter
Class StringToBigDecimalConverter

java.lang.Object
  com.vaadin.data.util.converter.AbstractStringToNumberConverter<java.math.BigDecimal>
      com.vaadin.data.util.converter.StringToBigDecimalConverter

All Implemented Interfaces:

Converter<java.lang.String,java.math.BigDecimal>, java.io.Serializable

public class StringToBigDecimalConverter
extends AbstractStringToNumberConverter<java.math.BigDecimal>

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

Leading and trailing white spaces are ignored when converting from a String.

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

Since:

7.2

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.util.converter.Converter

Converter.ConversionException

Constructor Summary

StringToBigDecimalConverter()

Method Summary

java.math.BigDecimal	convertToModel(java.lang.String value, java.lang.Class<? extends java.math.BigDecimal> targetType, java.util.Locale locale) Converts the given value from target type to source type.
protected java.text.NumberFormat	getFormat(java.util.Locale locale) Returns the format used by #convertToPresentation(Object, Locale) and #convertToModel(Object, Locale).
java.lang.Class<java.math.BigDecimal>	getModelType() The source type of the converter.

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

convertToNumber, convertToPresentation, getPresentationType

Methods inherited from class java.lang.Object

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

Constructor Detail

StringToBigDecimalConverter

public StringToBigDecimalConverter()

Method Detail

getFormat

protected java.text.NumberFormat getFormat(java.util.Locale locale)

Description copied from class: AbstractStringToNumberConverter

Returns the format used by #convertToPresentation(Object, Locale) and #convertToModel(Object, Locale).

Overrides:

getFormat in class AbstractStringToNumberConverter<java.math.BigDecimal>

Parameters:

locale - The locale to use

Returns:

A NumberFormat instance

convertToModel

public java.math.BigDecimal convertToModel(java.lang.String value,
                                           java.lang.Class<? extends java.math.BigDecimal> targetType,
                                           java.util.Locale locale)
                                    throws Converter.ConversionException

Description copied from interface: Converter

Converts the given value from target type to source type.

A converter can optionally use locale to do the conversion.

A converter should in most cases be symmetric so chaining Converter.convertToPresentation(Object, Class, Locale) and Converter.convertToModel(Object, Class, Locale) should return the original value.

Parameters:

value - The value to convert, compatible with the target type. Can be null

targetType - The requested type of the return value

locale - The locale to use for conversion. Can be null.

Returns:

The converted value compatible with the source type

Throws:

Converter.ConversionException - If the value could not be converted

getModelType

public java.lang.Class<java.math.BigDecimal> getModelType()

Description copied from interface: Converter

The source type of the converter. Values of this type can be passed to Converter.convertToPresentation(Object, Class, Locale).

Returns:

The source type