001    package org.apache.maven.model.validation;
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    import org.apache.maven.model.building.ModelBuildingRequest;
024    import org.apache.maven.model.building.ModelProblemCollector;
025    
026    /**
027     * Checks the model for missing or invalid values.
028     * 
029     * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
030     */
031    public interface ModelValidator
032    {
033    
034        /**
035         * Checks the specified (raw) model for missing or invalid values. The raw model is directly created from the POM
036         * file and has not been subjected to inheritance, interpolation or profile/default injection.
037         * 
038         * @param model The model to validate, must not be {@code null}.
039         * @param request The model building request that holds further settings, must not be {@code null}.
040         * @param problems The container used to collect problems that were encountered, must not be {@code null}.
041         */
042        void validateRawModel( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
043    
044        /**
045         * Checks the specified (effective) model for missing or invalid values. The effective model is fully assembled and
046         * has undergone inheritance, interpolation and other model operations.
047         * 
048         * @param model The model to validate, must not be {@code null}.
049         * @param request The model building request that holds further settings, must not be {@code null}.
050         * @param problems The container used to collect problems that were encountered, must not be {@code null}.
051         */
052        void validateEffectiveModel( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
053    
054    }