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.buildcache;
20  
21  import org.apache.maven.model.Model;
22  import org.apache.maven.project.MavenProject;
23  
24  /**
25   * Calculate normalized model for project. The idea is to have model where not all properties resolved. In particular
26   * ${project....} and ${pom....} replaced to some constant value. This helps to calculate correct checksum when changed
27   * only project version for example build 1 : 1.0-SNAPSHOT, build 2 : 2.0-SNAPSHOT in this case 2nd build could be
28   * completely restored from cache.
29   */
30  public interface NormalizedModelProvider {
31  
32      /**
33       * @param  project - the project which model will be calculated for
34       * @return         normalized model for project
35       */
36      Model normalizedModel(MavenProject project);
37  }