View Javadoc

1   /*
2    *  Copyright 2003-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  package org.apache.commons.convert1;
17  
18  
19  /**
20   * <p>General purpose data type converter that can be registered and used
21   * within the BeanUtils package to manage the conversion of objects from
22   * one type to another.
23   *
24   * @author Craig McClanahan
25   * @author Paulo Gaspar
26   * @version $Id: Converter.java 155441 2005-02-26 13:19:22Z dirkv $
27   * @since 0.1
28   */
29  
30  public interface Converter {
31  
32  
33      /**
34       * Convert the specified 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       *
40       * @exception ConversionException if conversion cannot be performed
41       *  successfully
42       */
43      public Object convert(Class type, Object value);
44  
45  
46  }