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.interpolation;
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 import org.apache.maven.model.building.ModelProblemCollector;
27
28 /**
29 * Replaces expressions of the form <code>${token}</code> with their effective values. Effective values are basically
30 * calculated from the elements of the model itself and the execution properties from the building request.
31 *
32 */
33 public interface ModelInterpolator {
34
35 /**
36 * Interpolates expressions in the specified model. Note that implementations are free to either interpolate the
37 * provided model directly or to create a clone of the model and interpolate the clone. Callers should always use
38 * the returned model and must not rely on the input model being updated.
39 *
40 * @param model The model to interpolate, must not be {@code null}.
41 * @param projectDir The project directory, may be {@code null} if the model does not belong to a local project but
42 * to some artifact's metadata.
43 * @param request The model building request that holds further settings, must not be {@code null}.
44 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
45 * @return The interpolated model, never {@code null}.
46 * @deprecated Use {@link #interpolateModel(Model, Path, ModelBuildingRequest, ModelProblemCollector)} instead.
47 */
48 @Deprecated
49 Model interpolateModel(Model model, File projectDir, ModelBuildingRequest request, ModelProblemCollector problems);
50
51 @Deprecated
52 org.apache.maven.api.model.Model interpolateModel(
53 org.apache.maven.api.model.Model model,
54 File projectDir,
55 ModelBuildingRequest request,
56 ModelProblemCollector problems);
57
58 /**
59 * Interpolates expressions in the specified model. Note that implementations are free to either interpolate the
60 * provided model directly or to create a clone of the model and interpolate the clone. Callers should always use
61 * the returned model and must not rely on the input model being updated.
62 *
63 * @param model The model to interpolate, must not be {@code null}.
64 * @param projectDir The project directory, may be {@code null} if the model does not belong to a local project but
65 * to some artifact's metadata.
66 * @param request The model building request that holds further settings, must not be {@code null}.
67 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
68 * @return The interpolated model, never {@code null}.
69 * @since 4.0.0
70 */
71 Model interpolateModel(Model model, Path projectDir, ModelBuildingRequest request, ModelProblemCollector problems);
72
73 /**
74 * @since 4.0.0
75 */
76 org.apache.maven.api.model.Model interpolateModel(
77 org.apache.maven.api.model.Model model,
78 Path projectDir,
79 ModelBuildingRequest request,
80 ModelProblemCollector problems);
81 }