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 */
017
018package org.apache.commons.beanutils2.locale.converters;
019
020import java.text.ParseException;
021import java.util.Locale;
022
023import org.apache.commons.beanutils2.ConversionException;
024
025/**
026 * Standard {@link org.apache.commons.beanutils2.locale.LocaleConverter} implementation that converts an incoming locale-sensitive String into a {@link Double}
027 * object, optionally using a default value or throwing a {@link org.apache.commons.beanutils2.ConversionException} if a conversion error occurs.
028 */
029public class DoubleLocaleConverter extends DecimalLocaleConverter<Double> {
030
031    /**
032     * Builds instances of {@link ByteLocaleConverter}.
033     */
034    public static class Builder extends DecimalLocaleConverter.Builder<Builder, Double> {
035
036        /**
037         * Constructs a new instance.
038         */
039        public Builder() {
040            // empty
041        }
042
043        @Override
044        public DoubleLocaleConverter get() {
045            return new DoubleLocaleConverter(defaultValue, locale, pattern, useDefault || defaultValue != null, localizedPattern);
046        }
047
048    }
049
050    /**
051     * Constructs a new builder.
052     *
053     * @return a new builder.
054     */
055    public static Builder builder() {
056        return new Builder();
057    }
058
059    private DoubleLocaleConverter(final Double defaultValue, final Locale locale, final String pattern, final boolean useDefault, final boolean locPattern) {
060        super(defaultValue, locale, pattern, useDefault, locPattern);
061    }
062
063    /**
064     * Parses the specified locale-sensitive input object into an output object of the specified type. This method will return Double type.
065     *
066     * @param value   The input object to be converted
067     * @param pattern The pattern is used for the conversion
068     * @return The converted value
069     * @throws ConversionException if conversion cannot be performed successfully
070     * @throws ParseException      if an error occurs parsing a String to a Number
071     */
072    @Override
073    protected Double parse(final Object value, final String pattern) throws ParseException {
074        final Number result = super.parse(value, pattern);
075        if (result instanceof Long) {
076            return Double.valueOf(result.doubleValue());
077        }
078        return (Double) result;
079    }
080}