1 package org.apache.maven.lifecycle;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.util.List;
23 import java.util.Map;
24
25 import org.apache.maven.execution.MavenSession;
26 import org.apache.maven.lifecycle.internal.DefaultLifecycleMappingDelegate;
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.project.MavenProject;
34
35 /**
36 * Lifecycle mapping delegate component interface. Calculates project build execution plan given {@link Lifecycle} and
37 * lifecycle phase. Standard lifecycles use plugin execution {@code <phase>} or mojo default lifecycle phase to
38 * calculate the execution plan, but custom lifecycles can use alternative mapping strategies.
39 * <p>
40 * Implementations of this interface must be annotated with either {@code @Named("lifecycle-id")} or equivalent plexus
41 * {@code @Component} annotations.
42 *
43 * @since 3.2.0
44 * @see DefaultLifecycleMappingDelegate
45 * @author ifedorenko
46 */
47 public interface LifecycleMappingDelegate
48 {
49 Map<String, List<MojoExecution>> calculateLifecycleMappings( MavenSession session, MavenProject project,
50 Lifecycle lifecycle, String lifecyclePhase )
51 throws PluginNotFoundException, PluginResolutionException, PluginDescriptorParsingException,
52 MojoNotFoundException, InvalidPluginDescriptorException;
53 }