View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.lifecycle.internal;
20  
21  import java.util.List;
22  import java.util.Set;
23  import org.apache.maven.execution.MavenSession;
24  import org.apache.maven.lifecycle.LifecycleNotFoundException;
25  import org.apache.maven.lifecycle.LifecyclePhaseNotFoundException;
26  import org.apache.maven.lifecycle.MavenExecutionPlan;
27  import org.apache.maven.plugin.InvalidPluginDescriptorException;
28  import org.apache.maven.plugin.MojoExecution;
29  import org.apache.maven.plugin.MojoNotFoundException;
30  import org.apache.maven.plugin.PluginDescriptorParsingException;
31  import org.apache.maven.plugin.PluginNotFoundException;
32  import org.apache.maven.plugin.PluginResolutionException;
33  import org.apache.maven.plugin.descriptor.MojoDescriptor;
34  import org.apache.maven.plugin.prefix.NoPluginFoundForPrefixException;
35  import org.apache.maven.plugin.version.PluginVersionResolutionException;
36  import org.apache.maven.project.MavenProject;
37  
38  /**
39   * @since 3.0
40   * @author Benjamin Bentmann
41   * @author Kristian Rosenvold  (extract interface only)
42   */
43  public interface LifecycleExecutionPlanCalculator {
44      MavenExecutionPlan calculateExecutionPlan(MavenSession session, MavenProject project, List<Object> tasks)
45              throws PluginNotFoundException, PluginResolutionException, LifecyclePhaseNotFoundException,
46                      PluginDescriptorParsingException, MojoNotFoundException, InvalidPluginDescriptorException,
47                      NoPluginFoundForPrefixException, LifecycleNotFoundException, PluginVersionResolutionException;
48  
49      MavenExecutionPlan calculateExecutionPlan(
50              MavenSession session, MavenProject project, List<Object> tasks, boolean setup)
51              throws PluginNotFoundException, PluginResolutionException, LifecyclePhaseNotFoundException,
52                      PluginDescriptorParsingException, MojoNotFoundException, InvalidPluginDescriptorException,
53                      NoPluginFoundForPrefixException, LifecycleNotFoundException, PluginVersionResolutionException;
54  
55      void calculateForkedExecutions(MojoExecution mojoExecution, MavenSession session)
56              throws MojoNotFoundException, PluginNotFoundException, PluginResolutionException,
57                      PluginDescriptorParsingException, NoPluginFoundForPrefixException, InvalidPluginDescriptorException,
58                      LifecyclePhaseNotFoundException, LifecycleNotFoundException, PluginVersionResolutionException;
59  
60      void setupMojoExecution(
61              MavenSession session,
62              MavenProject project,
63              MojoExecution mojoExecution,
64              Set<MojoDescriptor> alreadyPlannedExecutions)
65              throws PluginNotFoundException, PluginResolutionException, PluginDescriptorParsingException,
66                      MojoNotFoundException, InvalidPluginDescriptorException, NoPluginFoundForPrefixException,
67                      LifecyclePhaseNotFoundException, LifecycleNotFoundException, PluginVersionResolutionException;
68  }