org.mapstruct.ap.conversion.ConversionProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mapstruct-processor Show documentation

An annotation processor for generating type-safe bean mappers

There is a newer version: 1.6.2

/**
 *  Copyright 2012-2014 Gunnar Morling (http://www.gunnarmorling.de/)
 *  and/or other contributors as indicated by the @authors tag. See the
 *  copyright.txt file in the distribution for a full listing of all
 *  contributors.
 *
 *  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.mapstruct.ap.conversion;

import org.mapstruct.ap.model.common.ConversionContext;

import org.mapstruct.ap.model.TypeConversion;

/**
 * Implementations create inline {@link TypeConversion}s such as
 *
 * 
 * {@code (long)source},
 * {@code Integer.valueOf(source)} or
 * {@code new SimpleDateFormat().format( source )}.
 * 
 *
 * @author Gunnar Morling
 */
public interface ConversionProvider {

    /**
     * Creates the conversion from source to target of a property mapping.
     *
     * @param sourceReference A reference to the source object, e.g.
     * {@code beanName.getFoo()}.
     * @param conversionContext ConversionContext providing optional information required for creating the conversion.
     *
     * @return A conversion from source to target.
     */
    TypeConversion to(String sourceReference, ConversionContext conversionContext);

    /**
     * Creates the conversion from target to source of a property mapping.
     *
     * @param targetReference A reference to the targetReference object, e.g.
     * {@code beanName.getFoo()}.
     * @param conversionContext ConversionContext providing optional information required for creating the conversion.
     *
     * @return A conversion from target to source.
     */
    TypeConversion from(String targetReference, ConversionContext conversionContext);
}