001    package org.apache.maven.model.path;
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    
022    import java.io.File;
023    
024    import org.apache.maven.model.Model;
025    import org.apache.maven.model.building.ModelBuildingRequest;
026    
027    /**
028     * Resolves relative paths of a model against a specific base directory.
029     * 
030     * @author Jason van Zyl
031     */
032    public interface ModelPathTranslator
033    {
034    
035        /**
036         * Resolves the well-known paths of the specified model against the given base directory. Paths within plugin
037         * configuration are not processed.
038         * 
039         * @param model The model whose paths should be resolved, may be {@code null}.
040         * @param basedir The base directory to resolve relative paths against, may be {@code null}.
041         * @param request The model building request that holds further settings, must not be {@code null}.
042         */
043        void alignToBaseDirectory( Model model, File basedir, ModelBuildingRequest request );
044    
045    }