View Javadoc

1   package org.apache.maven.model.superpom;
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  
24  /**
25   * Provides the super POM that all models implicitly inherit from.
26   * 
27   * @author Benjamin Bentmann
28   */
29  public interface SuperPomProvider
30  {
31  
32      /**
33       * Gets the super POM for the specified model version. The returned model is supposed to be read-only, i.e. if the
34       * caller intends to make updates to the model the return value must be cloned before updating to ensure the
35       * modifications don't affect future retrievals of the super POM.
36       * 
37       * @param version The model version to retrieve the super POM for (e.g. "4.0.0"), must not be {@code null}.
38       * @return The super POM, never {@code null}.
39       */
40      Model getSuperModel( String version );
41  
42  }