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