001    package org.apache.maven.model.superpom;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.maven.model.Model;
023    
024    /**
025     * Provides the super POM that all models implicitly inherit from.
026     * 
027     * @author Benjamin Bentmann
028     */
029    public interface SuperPomProvider
030    {
031    
032        /**
033         * Gets the super POM for the specified model version. The returned model is supposed to be read-only, i.e. if the
034         * caller intends to make updates to the model the return value must be cloned before updating to ensure the
035         * modifications don't affect future retrievals of the super POM.
036         * 
037         * @param version The model version to retrieve the super POM for (e.g. "4.0.0"), must not be {@code null}.
038         * @return The super POM, never {@code null}.
039         */
040        Model getSuperModel( String version );
041    
042    }