001package org.apache.maven.model.normalization;
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
022import org.apache.maven.model.Model;
023import org.apache.maven.model.building.ModelBuildingRequest;
024import org.apache.maven.model.building.ModelProblemCollector;
025
026/**
027 * Handles normalization of a model. In this context, normalization is the process of producing a canonical
028 * representation for models that physically look different but are semantically equivalent.
029 *
030 * @author Benjamin Bentmann
031 */
032public interface ModelNormalizer
033{
034
035    /**
036     * Merges duplicate elements like multiple declarations of the same build plugin in the specified model.
037     *
038     * @param model The model whose duplicate elements should be merged, 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 mergeDuplicates( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
043
044    /**
045     * Sets default values in the specified model that for technical reasons cannot be set directly in the Modello
046     * definition.
047     *
048     * @param model The model in which to set the default values, 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 injectDefaultValues( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
053
054}