View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      https://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.beanutils2.locale.converters;
19  
20  import java.text.ParseException;
21  import java.util.Locale;
22  
23  import org.apache.commons.beanutils2.ConversionException;
24  
25  /**
26   * Standard {@link org.apache.commons.beanutils2.locale.LocaleConverter} implementation that converts an incoming locale-sensitive String into a
27   * {@link java.math.BigDecimal} object, optionally using a default value or throwing a {@link org.apache.commons.beanutils2.ConversionException} if a conversion
28   * error occurs.
29   */
30  public class FloatLocaleConverter extends DecimalLocaleConverter<Float> {
31  
32      /**
33       * Builds instances of {@link ByteLocaleConverter}.
34       */
35      public static class Builder extends DecimalLocaleConverter.Builder<Builder, Float> {
36  
37          /**
38           * Constructs a new instance.
39           */
40          public Builder() {
41              // empty
42          }
43  
44          @Override
45          public FloatLocaleConverter get() {
46              return new FloatLocaleConverter(defaultValue, locale, pattern, useDefault || defaultValue != null, localizedPattern);
47          }
48  
49      }
50  
51      /**
52       * Constructs a new builder.
53       *
54       * @return a new builder.
55       */
56      public static Builder builder() {
57          return new Builder();
58      }
59  
60      private FloatLocaleConverter(final Float defaultValue, final Locale locale, final String pattern, final boolean useDefault, final boolean locPattern) {
61          super(defaultValue, locale, pattern, useDefault, locPattern);
62      }
63  
64      /**
65       * Parses the specified locale-sensitive input object into an output object of the specified type. This method will return Float value or throw exception if
66       * value cannot be stored in the Float.
67       *
68       * @param value   The input object to be converted
69       * @param pattern The pattern is used for the conversion
70       * @return The converted value
71       * @throws ConversionException if conversion cannot be performed successfully
72       * @throws ParseException      if an error occurs parsing a String to a Number
73       */
74      @Override
75      protected Float parse(final Object value, final String pattern) throws ParseException {
76          final Number parsed = super.parse(value, pattern);
77          final double doubleValue = parsed.doubleValue();
78          final double posDouble = doubleValue >= 0 ? doubleValue : doubleValue * -1;
79          if (posDouble != 0 && (posDouble < Float.MIN_VALUE || posDouble > Float.MAX_VALUE)) {
80              throw new ConversionException("Supplied number is not of type Float: " + parsed);
81          }
82          return Float.valueOf(parsed.floatValue()); // unlike superclass it returns Float type
83      }
84  }