View Javadoc

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