org.ameba.mapping.BeanMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ameba-lib Show documentation

Ameba Utilities

There is a newer version: 4.1.0-jdk17

/*
 * Copyright 2015-2024 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 org.ameba.mapping;

import java.util.List;

/**
 * A BeanMapper is used to map Java classes (e.g. JavaBeans) between different domain models.
 *
 * @author Heiko Scherrer
 */
public interface BeanMapper {

    /**
     * Convert an entity instance of type {@code S} to an instance of type {@code T}.
     *
     * @param entity The entity instance to convert from
     * @param clazz The target entity class type
     * @param  The source entity to convert
     * @param  The target type to convert to
     * @return A new instance of the target type
     */
     T map(S entity, Class clazz);

    /**
     * Convert an entity instance to a target instance considering the entity class types.
     *
     * @param source The entity instance to convert from
     * @param target The target instance to convert to
     * @param  The source entity to convert
     * @param  The target entity to convert
     * @return The source instance
     */
     T mapFromTo(S source, T target);

    /**
     * Convert a {@link java.util.List List} of entities to a particular target type.
     *
     * @param entities The List of entity instances to convert from
     * @param clazz The target entity class type.
     * @param  The source entities to convert
     * @param  The target type to convert to
     * @return The converted entities
     */
     List map(List entities, Class clazz);
}