]> source.dussan.org Git - vaadin-framework.git/blob
bd9392ee0130ad50a22fad8a959d4489c001a619
[vaadin-framework.git] /
1 /*
2  * Copyright 2000-2016 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 public abstract class AbstractStringToNumberConverter<T>
36         implements Converter<String, T> {
37
38     /**
39      * Returns the format used by {@link #convertToPresentation(Object, Locale)}
40      * and {@link #convertToModel(Object, Locale)}.
41      *
42      * @param locale
43      *            The locale to use
44      * @return A NumberFormat instance
45      * @since 7.1
46      */
47     protected NumberFormat getFormat(Locale locale) {
48         if (locale == null) {
49             locale = Locale.getDefault();
50         }
51
52         return NumberFormat.getNumberInstance(locale);
53     }
54
55     /**
56      * Convert the value to a Number using the given locale and
57      * {@link #getFormat(Locale)}.
58      *
59      * @param value
60      *            The value to convert
61      * @param locale
62      *            The locale to use for conversion
63      * @return The converted value
64      * @throws ConversionException
65      *             If there was a problem converting the value
66      * @since 7.1
67      */
68     protected Number convertToNumber(String value,
69             Class<? extends Number> targetType, Locale locale)
70             throws ConversionException {
71         if (value == null) {
72             return null;
73         }
74
75         // Remove leading and trailing white space
76         value = value.trim();
77
78         // Parse and detect errors. If the full string was not used, it is
79         // an error.
80         ParsePosition parsePosition = new ParsePosition(0);
81         Number parsedValue = getFormat(locale).parse(value, parsePosition);
82         if (parsePosition.getIndex() != value.length()) {
83             throw new ConversionException("Could not convert '" + value
84                     + "' to " + getModelType().getName());
85         }
86
87         if (parsedValue == null) {
88             // Convert "" to null
89             return null;
90         }
91
92         return parsedValue;
93     }
94
95     /*
96      * (non-Javadoc)
97      *
98      * @see
99      * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang
100      * .Object, java.util.Locale)
101      */
102     @Override
103     public String convertToPresentation(T value,
104             Class<? extends String> targetType, Locale locale)
105             throws ConversionException {
106         if (value == null) {
107             return null;
108         }
109
110         return getFormat(locale).format(value);
111     }
112
113     /*
114      * (non-Javadoc)
115      *
116      * @see com.vaadin.data.util.converter.Converter#getPresentationType()
117      */
118     @Override
119     public Class<String> getPresentationType() {
120         return String.class;
121     }
122
123 }