View Javadoc

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