View Javadoc
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.inheritance;
20  
21  import org.apache.maven.api.model.Model;
22  import org.apache.maven.model.building.ModelBuildingRequest;
23  import org.apache.maven.model.building.ModelProblemCollector;
24  
25  /**
26   * Handles inheritance of model values.
27   *
28   * @author Benjamin Bentmann
29   */
30  public interface InheritanceAssembler {
31  
32      /**
33       * Merges values from the specified parent model into the given child model. Implementations are expected to keep
34       * parent and child completely decoupled by injecting deep copies of objects into the child rather than the original
35       * objects from the parent.
36       *
37       * @param child The child model into which to merge the values inherited from the parent, must not be
38       *            <code>null</code>.
39       * @param parent The (read-only) parent model from which to inherit the values, 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      Model assembleModelInheritance(
44              Model child, Model parent, ModelBuildingRequest request, ModelProblemCollector problems);
45  }