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;
19
20 /**
21 * <p>
22 * General purpose data type converter that can be registered and used within the BeanUtils package to manage the conversion of objects from one type to
23 * another.
24 * </p>
25 *
26 * <p>
27 * Converter subclasses bundled with the BeanUtils library are required to be thread-safe, as users of the library may call conversion methods from more than
28 * one thread simultaneously.
29 * </p>
30 *
31 * <p>
32 * Custom converter subclasses created by users of the library can be non-thread-safe if the application using them is single-threaded. However it is
33 * recommended that they be written in a thread-safe manner anyway.
34 * </p>
35 *
36 * @param <T> the convert type.
37 * @since 1.3
38 */
39 @FunctionalInterface
40 public interface Converter<T> {
41
42 /**
43 * Convert the specified input object into an output object of the specified type.
44 *
45 * @param <R> the result type.
46 * @param type Data type to which this value should be converted
47 * @param value The input value to be converted
48 * @return The converted value
49 * @throws ConversionException if conversion cannot be performed successfully
50 */
51 <R> R convert(Class<R> type, Object value);
52
53 }