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.beanutils2.converters;
018
019import java.math.BigDecimal;
020
021/**
022 * {@link NumberConverter} implementation that handles conversion to and from <strong>java.math.BigDecimal</strong> objects.
023 * <p>
024 * This implementation can be configured to handle conversion either by using BigDecimal's default String conversion, or by using a Locale's pattern or by
025 * specifying a format pattern. See the {@link NumberConverter} documentation for further details.
026 * <p>
027 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
028 *
029 * @since 1.3
030 */
031public final class BigDecimalConverter extends NumberConverter<BigDecimal> {
032
033    /**
034     * Constructs a <strong>java.math.BigDecimal</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
035     */
036    public BigDecimalConverter() {
037        super(true);
038    }
039
040    /**
041     * Constructs a <strong>java.math.BigDecimal</strong> <em>Converter</em> that returns a default value if an error occurs.
042     *
043     * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
044     */
045    public BigDecimalConverter(final BigDecimal defaultValue) {
046        super(true, defaultValue);
047    }
048
049    /**
050     * Constructs a <strong>java.math.BigDecimal</strong> <em>Converter</em> that returns a default value if an error occurs.
051     *
052     * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
053     */
054    public BigDecimalConverter(final Number defaultValue) {
055        this(BigDecimal.valueOf(defaultValue.doubleValue()));
056    }
057
058    /**
059     * Gets the default type this {@code Converter} handles.
060     *
061     * @return The default type this {@code Converter} handles.
062     * @since 1.8.0
063     */
064    @Override
065    protected Class<BigDecimal> getDefaultType() {
066        return BigDecimal.class;
067    }
068
069}