001package org.apache.maven.model.profile;
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.Profile;
024import org.apache.maven.model.building.ModelBuildingRequest;
025import org.apache.maven.model.building.ModelProblemCollector;
026
027/**
028 * Handles profile injection into the model.
029 *
030 * @author Benjamin Bentmann
031 */
032public interface ProfileInjector
033{
034
035    /**
036     * Merges values from the specified profile into the given model. Implementations are expected to keep the profile
037     * and model completely decoupled by injecting deep copies rather than the original objects from the profile.
038     *
039     * @param model The model into which to merge the values defined by the profile, must not be <code>null</code>.
040     * @param profile The (read-only) profile whose values should be injected, may be <code>null</code>.
041     * @param request The model building request that holds further settings, must not be {@code null}.
042     * @param problems The container used to collect problems that were encountered, must not be {@code null}.
043     */
044    void injectProfile( Model model, Profile profile, ModelBuildingRequest request, ModelProblemCollector problems );
045
046}