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.profile;
20
21 import java.util.List;
22
23 import org.apache.maven.model.Model;
24 import org.apache.maven.model.Profile;
25 import org.apache.maven.model.building.ModelBuildingRequest;
26 import org.apache.maven.model.building.ModelProblemCollector;
27
28 /**
29 * Handles profile injection into the model.
30 *
31 */
32 public interface ProfileInjector {
33
34 /**
35 * Merges values from the specified profile into the given model. Implementations are expected to keep the profile
36 * and model completely decoupled by injecting deep copies rather than the original objects from the profile.
37 *
38 * @param model The model into which to merge the values defined by the profile, must not be <code>null</code>.
39 * @param profile The (read-only) profile whose values should be injected, may be <code>null</code>.
40 * @param request The model building request that holds further settings, must not be {@code null}.
41 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
42 */
43 void injectProfile(Model model, Profile profile, ModelBuildingRequest request, ModelProblemCollector problems);
44
45 /**
46 * Merges values from the specified profile into the given model. Implementations are expected to keep the profile
47 * and model completely decoupled by injecting deep copies rather than the original objects from the profile.
48 *
49 * @param model The model into which to merge the values defined by the profile, must not be <code>null</code>.
50 * @param profile The (read-only) profile whose values should be injected, may be <code>null</code>.
51 * @param request The model building request that holds further settings, must not be {@code null}.
52 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
53 */
54 default org.apache.maven.api.model.Model injectProfile(
55 org.apache.maven.api.model.Model model,
56 org.apache.maven.api.model.Profile profile,
57 ModelBuildingRequest request,
58 ModelProblemCollector problems) {
59 Model m = new Model(model);
60 injectProfile(m, profile != null ? new Profile(profile) : null, request, problems);
61 return m.getDelegate();
62 }
63
64 /**
65 * Merges values from the specified profile into the given model. Implementations are expected to keep the profile
66 * and model completely decoupled by injecting deep copies rather than the original objects from the profile.
67 *
68 * @param model The model into which to merge the values defined by the profile, must not be <code>null</code>.
69 * @param profiles The (read-only) list of profiles whose values should be injected, must not be <code>null</code>.
70 * @param request The model building request that holds further settings, must not be {@code null}.
71 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
72 */
73 default org.apache.maven.api.model.Model injectProfiles(
74 org.apache.maven.api.model.Model model,
75 List<org.apache.maven.api.model.Profile> profiles,
76 ModelBuildingRequest request,
77 ModelProblemCollector problems) {
78 for (org.apache.maven.api.model.Profile profile : profiles) {
79 if (profile != null) {
80 model = injectProfile(model, profile, request, problems);
81 }
82 }
83 return model;
84 }
85 }