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