001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.beanutils.converters;
018
019import java.math.BigDecimal;
020
021/**
022 * {@link NumberConverter} implementation that handles conversion to
023 * and from <strong>java.math.BigDecimal</strong> objects.
024 * <p>
025 * This implementation can be configured to handle conversion either
026 * by using BigDecimal's default String conversion, or by using a Locale's pattern
027 * or by specifying a format pattern. See the {@link NumberConverter}
028 * documentation for further details.
029 * <p>
030 * Can be configured to either return a <em>default value</em> or throw a
031 * <code>ConversionException</code> if a conversion error occurs.
032 *
033 * @since 1.3
034 */
035public final class BigDecimalConverter extends NumberConverter {
036
037    /**
038     * Construct a <strong>java.math.BigDecimal</strong> <em>Converter</em> that throws
039     * a <code>ConversionException</code> if an error occurs.
040     */
041    public BigDecimalConverter() {
042        super(true);
043    }
044
045    /**
046     * Construct a <strong>java.math.BigDecimal</strong> <em>Converter</em> that returns
047     * a default value if an error occurs.
048     *
049     * @param defaultValue The default value to be returned
050     * if the value to be converted is missing or an error
051     * occurs converting the value.
052     */
053    public BigDecimalConverter(final Object defaultValue) {
054        super(true, defaultValue);
055    }
056
057    /**
058     * Return the default type this <code>Converter</code> handles.
059     *
060     * @return The default type this <code>Converter</code> handles.
061     * @since 1.8.0
062     */
063    @Override
064    protected Class<BigDecimal> getDefaultType() {
065        return BigDecimal.class;
066    }
067
068}