View Javadoc

1   /*******************************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   * http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   *******************************************************************************/
19  package org.apache.commons.convert;
20  
21  /**
22   * ConverterCreator interface. Classes implement this interface to create
23   * a converter that can convert one Java object type to another.
24   * 
25   * <p>
26   * <code>ConverterCreator</code> is used to dynamically create converters
27   * for target classes that implement an interface.
28   * </p>
29   */
30  public interface ConverterCreator {
31      /** Creates a Converter that can convert the <code>sourceClass</code> to
32       * the <code>targetClass</code>. Returns <code>null</code> if this creator
33       * doesn't support the class pair.
34       *
35       * @param sourceClass The source <code>Class</code> to convert from
36       * @param targetClass The target <code>Class</code> to convert to
37       * @return A <code>Converter</code> that can convert <code>sourceClass</code>
38       * to <code>targetClass</code>
39       */
40      public <S, T> Converter<S, T> createConverter(Class<S> sourceClass, Class<T> targetClass);
41  }