001package org.apache.maven.lifecycle;
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.Map;
024
025import org.apache.maven.execution.MavenSession;
026import org.apache.maven.lifecycle.internal.DefaultLifecycleMappingDelegate;
027import org.apache.maven.plugin.InvalidPluginDescriptorException;
028import org.apache.maven.plugin.MojoExecution;
029import org.apache.maven.plugin.MojoNotFoundException;
030import org.apache.maven.plugin.PluginDescriptorParsingException;
031import org.apache.maven.plugin.PluginNotFoundException;
032import org.apache.maven.plugin.PluginResolutionException;
033import org.apache.maven.project.MavenProject;
034
035/**
036 * Lifecycle mapping delegate component interface. Calculates project build execution plan given {@link Lifecycle} and
037 * lifecycle phase. Standard lifecycles use plugin execution {@code <phase>} or mojo default lifecycle phase to
038 * calculate the execution plan, but custom lifecycles can use alternative mapping strategies.
039 * <p>
040 * Implementations of this interface must be annotated with either {@code @Named("lifecycle-id")} or equivalent plexus
041 * {@code @Component} annotations.
042 * 
043 * @since 3.2.0
044 * @see DefaultLifecycleMappingDelegate
045 * @author ifedorenko
046 */
047public interface LifecycleMappingDelegate
048{
049    Map<String, List<MojoExecution>> calculateLifecycleMappings( MavenSession session, MavenProject project,
050                                                                 Lifecycle lifecycle, String lifecyclePhase )
051        throws PluginNotFoundException, PluginResolutionException, PluginDescriptorParsingException,
052        MojoNotFoundException, InvalidPluginDescriptorException;
053}