source.dussan.org Git - vaadin-framework.git/blob

   1 /*
   2  * Copyright 2000-2021 Vaadin Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5  * use this file except in compliance with the License. You may obtain a copy of
   6  * the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13  * License for the specific language governing permissions and limitations under
  14  * the License.
  15  */
  16
  17 package com.vaadin.v7.data.util.converter;
  18
  19 import java.text.NumberFormat;
  20 import java.text.ParsePosition;
  21 import java.util.Locale;
  22
  23 /**
  24  * A converter that converts from the number type T to {@link String} and back.
  25  * Uses the given locale and {@link NumberFormat} for formatting and parsing.
  26  * Automatically trims the input string, removing any leading and trailing white
  27  * space.
  28  * <p>
  29  * Override and overwrite {@link #getFormat(Locale)} to use a different format.
  30  * </p>
  31  *
  32  * @author Vaadin Ltd
  33  * @since 7.1
  34  */
  35 @Deprecated
  36 public abstract class AbstractStringToNumberConverter<T>
  37         implements Converter<String, T> {
  38
  39     /**
  40      * Returns the format used by {@link #convertToPresentation(Object, Locale)}
  41      * and {@link #convertToModel(Object, Locale)}.
  42      *
  43      * @param locale
  44      *            The locale to use
  45      * @return A NumberFormat instance
  46      * @since 7.1
  47      */
  48     protected NumberFormat getFormat(Locale locale) {
  49         if (locale == null) {
  50             locale = Locale.getDefault();
  51         }
  52
  53         return NumberFormat.getNumberInstance(locale);
  54     }
  55
  56     /**
  57      * Convert the value to a Number using the given locale and
  58      * {@link #getFormat(Locale)}.
  59      *
  60      * @param value
  61      *            The value to convert
  62      * @param locale
  63      *            The locale to use for conversion
  64      * @return The converted value
  65      * @throws ConversionException
  66      *             If there was a problem converting the value
  67      * @since 7.1
  68      */
  69     protected Number convertToNumber(String value,
  70             Class<? extends Number> targetType, Locale locale)
  71             throws ConversionException {
  72         if (value == null) {
  73             return null;
  74         }
  75
  76         // Remove leading and trailing white space
  77         value = value.trim();
  78
  79         // Parse and detect errors. If the full string was not used, it is
  80         // an error.
  81         ParsePosition parsePosition = new ParsePosition(0);
  82         Number parsedValue = getFormat(locale).parse(value, parsePosition);
  83         if (parsePosition.getIndex() != value.length()) {
  84             throw new ConversionException("Could not convert '" + value
  85                     + "' to " + getModelType().getName());
  86         }
  87
  88         if (parsedValue == null) {
  89             // Convert "" to null
  90             return null;
  91         }
  92
  93         return parsedValue;
  94     }
  95
  96     /*
  97      * (non-Javadoc)
  98      *
  99      * @see
 100      * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang
 101      * .Object, java.util.Locale)
 102      */
 103     @Override
 104     public String convertToPresentation(T value,
 105             Class<? extends String> targetType, Locale locale)
 106             throws ConversionException {
 107         if (value == null) {
 108             return null;
 109         }
 110
 111         return getFormat(locale).format(value);
 112     }
 113
 114     /*
 115      * (non-Javadoc)
 116      *
 117      * @see com.vaadin.data.util.converter.Converter#getPresentationType()
 118      */
 119     @Override
 120     public Class<String> getPresentationType() {
 121         return String.class;
 122     }
 123
 124 }