001package org.apache.maven.model.building;
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 java.io.File;
023
024import org.apache.maven.model.Model;
025
026/**
027 * Builds the effective model from a POM.
028 *
029 * @author Benjamin Bentmann
030 */
031public interface ModelBuilder
032{
033
034    /**
035     * Builds the effective model of the specified POM.
036     *
037     * @param request The model building request that holds the parameters, must not be {@code null}.
038     * @return The result of the model building, never {@code null}.
039     * @throws ModelBuildingException If the effective model could not be built.
040     */
041    ModelBuildingResult build( ModelBuildingRequest request )
042        throws ModelBuildingException;
043
044    /**
045     * Builds the effective model by completing the specified interim result which was produced by a previous call to
046     * {@link #build(ModelBuildingRequest)} with {@link ModelBuildingRequest#isTwoPhaseBuilding()} being {@code true}.
047     * The model building request passed to this method must be the same as the one used for the first phase of the
048     * model building.
049     *
050     * @param request The model building request that holds the parameters, must not be {@code null}.
051     * @param result The interim result of the first phase of model building, must not be {@code null}.
052     * @return The result of the model building, never {@code null}.
053     * @throws ModelBuildingException If the effective model could not be built.
054     */
055    ModelBuildingResult build( ModelBuildingRequest request, ModelBuildingResult result )
056        throws ModelBuildingException;
057
058    /**
059     * Performs only the part of {@link ModelBuilder#build(ModelBuildingRequest)} that loads the raw model
060     *
061     * @param request
062     * @return
063     * @throws ModelBuildingException
064     */
065    Result<? extends Model> buildRawModel( File pomFile, int validationLevel, boolean locationTracking );
066
067}