    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one
    003 * or more contributor license agreements. See the NOTICE file
    004 * distributed with this work for additional information
    005 * regarding copyright ownership. The ASF licenses this file
    006 * to you under the Apache License, Version 2.0 (the
    007 * "License"); you may not use this file except in compliance
    008 * with the License. You may obtain a copy of the License at
    009 *
    010 * https://www.apache.org/licenses/LICENSE-2.0
    011 *
    012 * Unless required by applicable law or agreed to in writing,
    013 * software distributed under the License is distributed on an
    014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    015 * KIND, either express or implied. See the License for the
    016 * specific language governing permissions and limitations
    017 * under the License.
    018 */
    019package org.apache.commons.beanutils2.converters;
    020
    021import java.util.Locale;
    022
    023/**
    024 * {@link org.apache.commons.beanutils2.Converter} implementation that handles conversion to and from {@link Locale}.
    025 *
    026 * @since 2.0.0
    027 */
    028public class LocaleConverter extends AbstractConverter<Locale> {
    029
    030    /**
    031     * Construct a <strong>{@link Locale}</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
    032     */
    033    public LocaleConverter() {
    034    }
    035
    036    /**
    037     * Constructs a {@link org.apache.commons.beanutils2.Converter} that will return the specified default value if a conversion error occurs.
    038     *
    039     * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
    040     */
    041    public LocaleConverter(final Locale defaultValue) {
    042        super(defaultValue);
    043    }
    044
    045    /**
    046     * Converts the specified input object into an output object of the specified type.
    047     *
    048     * @param type  Data type to which this value should be converted.
    049     * @param value The String property value to convert.
    050     * @return A {@link Locale} which represents the configuration property value.
    051     * @throws NullPointerException If the value is null.
    052     */
    053    @Override
    054    protected <T> T convertToType(final Class<T> type, final Object value) throws Throwable {
    055        if (Locale.class.isAssignableFrom(type)) {
    056            final String stringValue = toString(value);
    057            return type.cast(Locale.forLanguageTag(stringValue));
    058        }
    059
    060        throw conversionException(type, value);
    061    }
    062
    063    /**
    064     * Gets the default type this {@code Converter} handles.
    065     *
    066     * @return The default type this {@code Converter} handles.
    067     * @since 2.0.0
    068     */
    069    @Override
    070    protected Class<Locale> getDefaultType() {
    071        return Locale.class;
    072    }
    073}