001package org.apache.maven.lifecycle.internal.builder;
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.util.List;
023import java.util.concurrent.ExecutionException;
024
025import org.apache.maven.execution.MavenSession;
026import org.apache.maven.lifecycle.internal.ProjectBuildList;
027import org.apache.maven.lifecycle.internal.ReactorBuildStatus;
028import org.apache.maven.lifecycle.internal.ReactorContext;
029import org.apache.maven.lifecycle.internal.TaskSegment;
030
031/**
032 * A {@link Builder} encapsulates a strategy for building a set of Maven projects. The default strategy in Maven builds
033 * the the projects serially, but a {@link Builder} can employ any type of concurrency model to build the projects.
034 *
035 * @author jvanzyl
036 * @provisional
037 */
038public interface Builder
039{
040    //
041    // Be nice to whittle this down to Session, maybe add task segments to the session. The session really is the
042    // the place to store reactor related information.
043    //
044    void build( MavenSession session, ReactorContext reactorContext, ProjectBuildList projectBuilds,
045                List<TaskSegment> taskSegments, ReactorBuildStatus reactorBuildStatus )
046        throws ExecutionException, InterruptedException;
047}