com.github.mjeanroy.spring.mappers.objects.ObjectMapper Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2014 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.github.mjeanroy.spring.mappers.objects;

import java.util.Map;

import org.springframework.core.convert.converter.Converter;

/**
 * Mapper that can transform object of type T to objects of
 * type U.
 *
 * This mapper support transformation of iterable structure of type T
 * to iterable structure of type U.
 *
 * @param  Original type.
 * @param  New type.
 */
public interface ObjectMapper extends Converter {

	/**
	 * Transform source object to destination object.
	 * Implementation must be null-safe (do not produce {@link NullPointerException}).
	 *
	 * @param source Source object.
	 * @return Destination object.
	 */
	U from(T source);

	/**
	 * Transform source object to destination object.
	 * This method assumes that source object is NOT NULL.
	 *
	 * @param source Source object.
	 * @return Destination object.
	 */
	U convert(T source);

	/**
	 * Transform iterable structure of type U to new iterable structure
	 * of type T.
	 *
	 * @param sources Source objects.
	 * @return Destination objects.
	 */
	Iterable from(Iterable sources);

	/**
	 * Transform map structure of type U to new map structure
	 * of type T.
	 *
	 * @param sources Source objects.
	 * @return Destination objects.
	 */
	 Map from(Map sources);
}