1 package org.apache.maven.model.path;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23
24 import org.apache.maven.model.Model;
25 import org.apache.maven.model.building.ModelBuildingRequest;
26
27 /**
28 * Resolves relative paths of a model against a specific base directory.
29 *
30 * @author Jason van Zyl
31 */
32 public interface ModelPathTranslator
33 {
34
35 /**
36 * Resolves the well-known paths of the specified model against the given base directory. Paths within plugin
37 * configuration are not processed.
38 *
39 * @param model The model whose paths should be resolved, may be {@code null}.
40 * @param basedir The base directory to resolve relative paths against, may be {@code null}.
41 * @param request The model building request that holds further settings, must not be {@code null}.
42 */
43 void alignToBaseDirectory( Model model, File basedir, ModelBuildingRequest request );
44
45 }