net.entropysoft.transmorph.Transmorph Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transmorph Show documentation
Java library to convert a Java object of one type into an object of another type (with another signature, possibly parameterized).
There is a newer version: 3.1.3
Show newest version
/*
 * Copyright 2008-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.entropysoft.transmorph;

import java.lang.reflect.Type;
import java.text.MessageFormat;

import net.entropysoft.transmorph.converters.MultiConverter;
import net.entropysoft.transmorph.type.TypeReference;

/**
 * Convert an object to another object.
 * 
 * 
 * This class is not thread-safe
 * 
 * 
 * @author Cedric Chabanois (cchabanois at gmail.com)
 * 
 */
public class Transmorph {

	private MultiConverter multiConverter;

	/**
	 * Creates Transmorph object
	 * 
	 * @param classLoader
	 *            classLoader to use when loading classes by name
	 * @param converters
	 *            the converter that will be used.
	 */
	public Transmorph(IConverter converter) {
		// this constructor is not really needed but when converted to JDK 1.4,
		// it is useful
		this(new IConverter[] { converter });
	}

	/**
	 * Creates Transmorph Object.
	 * 
	 * @param typeFactory
	 *            factory that creates types from their signatures
	 * @param converters
	 *            the converters that will be used. The order is important as
	 *            they will be tried one by one in order
	 */
	public Transmorph(IConverter... converters) {
		this.multiConverter = new MultiConverter(false, converters);
		this.multiConverter.setElementConverter(multiConverter);
	}

	/**
	 * Convert an object to another object with given type
	 * 
	 * @param 
	 * @param source
	 *            object to convert
	 * @param typeReference
	 *            reference to {@link java.lang.reflect.Type}
	 * @return the converted object if conversion failed
	 * @throws ConverterException
	 */
	public  T convert(Object source, TypeReference typeReference)
			throws ConverterException {
		return (T) convert(new ConversionContext(), source, typeReference);
	}

	public  T convert(Object source, Class clazz, Class[] typeArgs)
			throws ConverterException {
		return clazz.cast(convert(new ConversionContext(), source,
				TypeReference.get(clazz, typeArgs)));
	}

	public Object convert(Object source, Type type) throws ConverterException {
		return convert(new ConversionContext(), source, TypeReference.get(type));
	}

	/**
	 * Convert an object to another object with given class
	 * 
	 * @param 
	 * @param source
	 *            object to convert
	 * @param clazz
	 *            destination class
	 * @return the converted object
	 * @throws ConverterException
	 *             if conversion failed
	 */
	public  T convert(Object source, Class clazz)
			throws ConverterException {
		return (T) convert(new ConversionContext(), source, clazz);
	}

	/**
	 * Convert an object to another object with given class
	 * 
	 * @param 
	 * @param context
	 * @param source
	 *            object to convert
	 * @param clazz
	 *            destination class
	 * @return the converted object
	 * @throws ConverterException
	 *             if conversion failed
	 */
	public  T convert(ConversionContext context, Object source,
			Class clazz) throws ConverterException {
		return (T) convert(context, source, TypeReference.get(clazz));
	}

	public Object convert(ConversionContext context, Object source, Type type)
			throws ConverterException {
		return convert(context, source, TypeReference.get(type));
	}

	/**
	 * Convert an object to another object given a parameterized type signature
	 * 
	 * @param context
	 * @param destinationType
	 *            the destination type
	 * @param source
	 *            the source object
	 * 
	 * @return the converted object
	 * @throws ConverterException
	 *             if conversion failed
	 */
	public  T convert(ConversionContext context, Object source,
			TypeReference destinationType) throws ConverterException {
		try {
			return (T) multiConverter.convert(context, source, destinationType);
		} catch (ConverterException e) {
			throw e;
		} catch (Exception e) {
			// There is a problem with one converter. This should not happen.
			// Either there is a bug in this converter or it is not properly
			// configured
			throw new ConverterException(
					MessageFormat
							.format(
									"Could not convert given object with class ''{0}'' to object with type signature ''{1}''",
									source == null ? "null" : source.getClass()
											.getName(), destinationType), e);
		}
	}

	public boolean canHandle(ConversionContext context, Object sourceObject,
			TypeReference destinationType) {
		return multiConverter.canHandle(context, sourceObject, destinationType);
	}

}