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