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.api;
20
21 import java.util.Optional;
22
23 import org.apache.maven.api.annotations.Experimental;
24 import org.apache.maven.api.annotations.Nonnull;
25 import org.apache.maven.api.model.PluginExecution;
26 import org.apache.maven.api.plugin.descriptor.MojoDescriptor;
27 import org.apache.maven.api.xml.XmlNode;
28
29 /**
30 * A {@code MojoExecution} represents a single execution of a Maven Plugin during a given build.
31 * An instance of this object is bound to the {@link org.apache.maven.api.di.MojoExecutionScoped}
32 * and available as {@code mojoExecution} within {@link org.apache.maven.api.plugin.annotations.Parameter}
33 * expressions.
34 */
35 @Experimental
36 public interface MojoExecution {
37
38 @Nonnull
39 Plugin getPlugin();
40
41 @Nonnull
42 PluginExecution getModel();
43
44 @Nonnull
45 MojoDescriptor getDescriptor();
46
47 @Nonnull
48 String getExecutionId();
49
50 @Nonnull
51 String getGoal();
52
53 @Nonnull
54 String getLifecyclePhase();
55
56 @Nonnull
57 Optional<XmlNode> getConfiguration();
58 }