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;
20
21 import java.util.List;
22 import java.util.Map;
23
24 import org.apache.maven.execution.MavenSession;
25 import org.apache.maven.plugin.InvalidPluginDescriptorException;
26 import org.apache.maven.plugin.MojoExecution;
27 import org.apache.maven.plugin.MojoNotFoundException;
28 import org.apache.maven.plugin.PluginDescriptorParsingException;
29 import org.apache.maven.plugin.PluginNotFoundException;
30 import org.apache.maven.plugin.PluginResolutionException;
31 import org.apache.maven.project.MavenProject;
32
33 /**
34 * Lifecycle mapping delegate component interface. Calculates project build execution plan given {@link Lifecycle} and
35 * lifecycle phase. Standard lifecycles use plugin execution {@code <phase>} or mojo default lifecycle phase to
36 * calculate the execution plan, but custom lifecycles can use alternative mapping strategies.
37 * <p>
38 * Implementations of this interface must be annotated with either {@code @Named("lifecycle-id")} or equivalent plexus
39 * {@code @Component} annotations.
40 *
41 * @since 3.2.0
42 * @see org.apache.maven.lifecycle.internal.DefaultLifecycleMappingDelegate
43 */
44 public interface LifecycleMappingDelegate {
45 Map<String, List<MojoExecution>> calculateLifecycleMappings(
46 MavenSession session, MavenProject project, Lifecycle lifecycle, String lifecyclePhase)
47 throws PluginNotFoundException, PluginResolutionException, PluginDescriptorParsingException,
48 MojoNotFoundException, InvalidPluginDescriptorException;
49 }