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