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 * http://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 package org.apache.commons.beanutils2.converters;
18
19 /**
20 * {@link NumberConverter} implementation that handles conversion to and from <strong>java.lang.Float</strong> objects.
21 * <p>
22 * This implementation can be configured to handle conversion either by using Float's default String conversion, or by using a Locale's pattern or by specifying
23 * a format pattern. See the {@link NumberConverter} documentation for further details.
24 * <p>
25 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
26 *
27 * @since 1.3
28 */
29 public final class FloatConverter extends NumberConverter<Float> {
30
31 /**
32 * Constructs a <strong>java.lang.Float</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
33 */
34 public FloatConverter() {
35 super(true);
36 }
37
38 /**
39 * Constructs a <strong>java.lang.Float</strong> <em>Converter</em> that returns a default value if an error occurs.
40 *
41 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
42 */
43 public FloatConverter(final Float defaultValue) {
44 super(true, defaultValue);
45 }
46
47 /**
48 * Constructs a <strong>java.lang.Float</strong> <em>Converter</em> that returns a default value if an error occurs.
49 *
50 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
51 */
52 public FloatConverter(final Number defaultValue) {
53 this(defaultValue.floatValue());
54 }
55
56 /**
57 * Gets the default type this {@code Converter} handles.
58 *
59 * @return The default type this {@code Converter} handles.
60 * @since 1.8.0
61 */
62 @Override
63 protected Class<Float> getDefaultType() {
64 return Float.class;
65 }
66
67 }