View Javadoc

1   package org.apache.maven.model.interpolation;
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  import java.io.File;
27  
28  /**
29   * Replaces expressions of the form <tt>${token}</tt> with their effective values. Effective values are basically
30   * calculated from the elements of the model itself and the execution properties from the building request.
31   *
32   * @author jdcasey
33   *         <p/>
34   *         Created on Feb 2, 2005
35   */
36  public interface ModelInterpolator
37  {
38  
39      /**
40       * Interpolates expressions in the specified model. Note that implementations are free to either interpolate the
41       * provided model directly or to create a clone of the model and interpolate the clone. Callers should always use
42       * the returned model and must not rely on the input model being updated.
43       *
44       * @param model The model to interpolate, must not be {@code null}.
45       * @param projectDir The project directory, may be {@code null} if the model does not belong to a local project but
46       *            to some artifact's metadata.
47       * @param request The model building request that holds further settings, must not be {@code null}.
48       * @param problems The container used to collect problems that were encountered, must not be {@code null}.
49       * @return The interpolated model, never {@code null}.
50       */
51      Model interpolateModel( Model model, File projectDir, ModelBuildingRequest request,
52                              ModelProblemCollector problems );
53  
54  }