1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.beanutils2.locale;
19
20 import org.apache.commons.beanutils2.ConversionException;
21 import org.apache.commons.beanutils2.Converter;
22
23 /**
24 * <p>
25 * General purpose locale-sensitive data type converter that can be registered and used within the BeanUtils package to manage the conversion of objects from
26 * one type to another.
27 *
28 * @param <T> The converter type.
29 */
30 public interface LocaleConverter<T> extends Converter<T> {
31
32 /**
33 * Convert the specified locale-sensitive input object into an output object of the specified type.
34 *
35 * @param <R> the result type.
36 * @param type Data type to which this value should be converted
37 * @param value The input value to be converted
38 * @param pattern The user-defined pattern is used for the input object formatting.
39 * @return The converted value
40 * @throws ConversionException if conversion cannot be performed successfully or if the target type is not supported
41 */
42 <R> R convert(Class<R> type, Object value, String pattern);
43 }