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