org.fabric3.spi.transform.TransformerRegistry Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation
SPIs for runtime extensions
There is a newer version: 2.0.1
/*
* Fabric3
* Copyright (c) 2009 Metaform Systems
*
* Fabric3 is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version, with the
* following exception:
*
* Linking this software statically or dynamically with other
* modules is making a combined work based on this software.
* Thus, the terms and conditions of the GNU General Public
* License cover the whole combination.
*
* As a special exception, the copyright holders of this software
* give you permission to link this software with independent
* modules to produce an executable, regardless of the license
* terms of these independent modules, and to copy and distribute
* the resulting executable under terms of your choice, provided
* that you also meet, for each linked independent module, the
* terms and conditions of the license of that module. An
* independent module is a module which is not derived from or
* based on this software. If you modify this software, you may
* extend this exception to your version of the software, but
* you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version.
*
* Fabric3 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
* You should have received a copy of the
* GNU General Public License along with Fabric3.
* If not, see .
*/
package org.fabric3.spi.transform;

import java.util.List;

import org.fabric3.model.type.contract.DataType;

/**
 * Registry of Transformers.
 *
 * @version $Rev: 8348 $ $Date: 2009-12-01 11:19:44 +0000 (Tue, 01 Dec 2009) $
 */
public interface TransformerRegistry {

    /**
     * Returns a transformer that can convert a set of classes from the source to target data type. The source and target data types may be Java
     * types, XML Schema types, etc. The in and out types represent the classes that must be converted.
     *
     * @param source   the data type to transform from
     * @param target   the data type to transform to
     * @param inTypes  the classes that must be converted from
     * @param outTypes the classes that must be converted to
     * @return the transformer or null if one is not found
     * @throws TransformationException if an error occurs returning the transformer
     */
    Transformer getTransformer(DataType source, DataType target, List> inTypes, List> outTypes)
            throws TransformationException;


}