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 Integer}
027 * object, optionally using a default value or throwing a {@link org.apache.commons.beanutils2.ConversionException} if a conversion error occurs.
028 */
029public class IntegerLocaleConverter extends DecimalLocaleConverter<Integer> {
030
031    /**
032     * Builds instances of {@link ByteLocaleConverter}.
033     */
034    public static class Builder extends DecimalLocaleConverter.Builder<Builder, Integer> {
035
036        @Override
037        public IntegerLocaleConverter get() {
038            return new IntegerLocaleConverter(defaultValue, locale, pattern, useDefault || defaultValue != null, localizedPattern);
039        }
040
041    }
042
043    /**
044     * Constructs a new builder.
045     *
046     * @return a new builder.
047     */
048    public static Builder builder() {
049        return new Builder();
050    }
051
052    private IntegerLocaleConverter(final Integer defaultValue, final Locale locale, final String pattern, final boolean useDefault, final boolean locPattern) {
053        super(defaultValue, locale, pattern, useDefault, locPattern);
054    }
055
056    /**
057     * Parses the specified locale-sensitive input object into an output object of the specified type. This method will return Integer type.
058     *
059     * @param value   The input object to be converted
060     * @param pattern The pattern is used for the conversion
061     * @return The converted value
062     * @throws ConversionException if conversion cannot be performed successfully
063     * @throws ParseException      if an error occurs parsing a String to a Number
064     */
065    @Override
066    protected Integer parse(final Object value, final String pattern) throws ParseException {
067        final Number parsed = super.parse(value, pattern);
068        if (parsed.longValue() != parsed.intValue()) {
069            throw new ConversionException("Supplied number is not of type Integer: " + parsed.longValue());
070        }
071        return Integer.valueOf(parsed.intValue()); // unlike superclass it will return proper Integer
072    }
073}