001package org.apache.maven.model.interpolation;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.model.Model;
023import org.apache.maven.model.building.ModelBuildingRequest;
024import org.apache.maven.model.building.ModelProblemCollector;
025
026import java.io.File;
027
028/**
029 * Replaces expressions of the form <tt>${token}</tt> with their effective values. Effective values are basically
030 * calculated from the elements of the model itself and the execution properties from the building request.
031 *
032 * @author jdcasey
033 *         <p/>
034 *         Created on Feb 2, 2005
035 */
036public interface ModelInterpolator
037{
038
039    /**
040     * Interpolates expressions in the specified model. Note that implementations are free to either interpolate the
041     * provided model directly or to create a clone of the model and interpolate the clone. Callers should always use
042     * the returned model and must not rely on the input model being updated.
043     *
044     * @param model The model to interpolate, must not be {@code null}.
045     * @param projectDir The project directory, may be {@code null} if the model does not belong to a local project but
046     *            to some artifact's metadata.
047     * @param request The model building request that holds further settings, must not be {@code null}.
048     * @param problems The container used to collect problems that were encountered, must not be {@code null}.
049     * @return The interpolated model, never {@code null}.
050     */
051    Model interpolateModel( Model model, File projectDir, ModelBuildingRequest request,
052                            ModelProblemCollector problems );
053
054}