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;
019
020import org.apache.commons.beanutils2.ConversionException;
021import org.apache.commons.beanutils2.Converter;
022
023/**
024 * <p>
025 * General purpose locale-sensitive data type converter that can be registered and used within the BeanUtils package to manage the conversion of objects from
026 * one type to another.
027 *
028 * @param <T> The converter type.
029 */
030public interface LocaleConverter<T> extends Converter<T> {
031
032    /**
033     * Convert the specified locale-sensitive input object into an output object of the specified type.
034     *
035     * @param <R>     the result type.
036     * @param type    Data type to which this value should be converted
037     * @param value   The input value to be converted
038     * @param pattern The user-defined pattern is used for the input object formatting.
039     * @return The converted value
040     * @throws ConversionException if conversion cannot be performed successfully or if the target type is not supported
041     */
042    <R> R convert(Class<R> type, Object value, String pattern);
043}