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 org.apache.maven.model.Model;
22 import org.apache.maven.model.Profile;
23 import org.apache.maven.model.building.ModelBuildingRequest;
24 import org.apache.maven.model.building.ModelProblemCollector;
25
26 /**
27 * Handles profile injection into the model.
28 *
29 * @author Benjamin Bentmann
30 */
31 public interface ProfileInjector {
32
33 /**
34 * Merges values from the specified profile into the given model. Implementations are expected to keep the profile
35 * and model completely decoupled by injecting deep copies rather than the original objects from the profile.
36 *
37 * @param model The model into which to merge the values defined by the profile, must not be <code>null</code>.
38 * @param profile The (read-only) profile whose values should be injected, may be <code>null</code>.
39 * @param request The model building request that holds further settings, must not be {@code null}.
40 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
41 */
42 void injectProfile(Model model, Profile profile, ModelBuildingRequest request, ModelProblemCollector problems);
43 }