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