com.github.dozermapper.core.Mapper Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2005-2019 Dozer Project
 *
 * 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 com.github.dozermapper.core;

import com.github.dozermapper.core.metadata.MappingMetadata;

/**
 * Public root interface for performing Dozer mappings from application code.
 */
public interface Mapper {

    /**
     * Constructs new instance of destinationClass and performs mapping between from source
     *
     * @param source           object to convert from
     * @param destinationClass type to convert to
     * @param               type to convert to
     * @return mapped object
     * @throws MappingException mapping failure
     */
     T map(Object source, Class destinationClass) throws MappingException;

    /**
     * Performs mapping between source and destination objects
     *
     * @param source      object to convert from
     * @param destination object to convert to
     * @throws MappingException mapping failure
     */
    void map(Object source, Object destination) throws MappingException;

    /**
     * Constructs new instance of destinationClass and performs mapping between from source
     *
     * @param source           object to convert from
     * @param destinationClass type to convert to
     * @param mapId            id in configuration for mapping
     * @param               type to convert to
     * @return mapped object
     * @throws MappingException mapping failure
     */
     T map(Object source, Class destinationClass, String mapId) throws MappingException;

    /**
     * Performs mapping between source and destination objects
     *
     * @param source      object to convert from
     * @param destination object to convert to
     * @param mapId       id in configuration for mapping
     * @throws MappingException mapping failure
     */
    void map(Object source, Object destination, String mapId) throws MappingException;

    /**
     * The {@link com.github.dozermapper.core.metadata.MappingMetadata} interface can be used to query information about the current
     * mapping definitions. It provides read only access to all important classes and field
     * mapping properties. When first called, initializes all mappings if map() has not yet been called.
     *
     * @return An instance of {@link com.github.dozermapper.core.metadata.MappingMetadata} which serves starting point
     * for querying mapping information.
     */
    default MappingMetadata getMappingMetadata() {
        return MappingMetadata.EMPTY;
    }

    /**
     * Returns {@link MapperModelContext} which allows readonly access to the Mapper model
     *
     * @return an instance of {@link MapperModelContext}
     */
    MapperModelContext getMapperModelContext();
}