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