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.plugin.annotations;
20
21 import java.lang.annotation.Documented;
22 import java.lang.annotation.ElementType;
23 import java.lang.annotation.Inherited;
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.RetentionPolicy;
26 import java.lang.annotation.Target;
27
28 import org.apache.maven.api.annotations.Experimental;
29 import org.apache.maven.api.annotations.Nonnull;
30
31 /**
32 * Used if your Mojo needs to fork a <a href="/ref/3.0.4/maven-core/lifecycles.html">lifecycle</a>.
33 *
34 * @since 4.0.0
35 */
36 @Experimental
37 @Documented
38 @Retention(RetentionPolicy.RUNTIME)
39 @Target(ElementType.TYPE)
40 @Inherited
41 public @interface Execute {
42 /**
43 * Lifecycle phase to fork. Note that specifying a phase overrides specifying a goal.
44 * @return the phase
45 */
46 @Nonnull
47 String phase() default "";
48
49 /**
50 * Goal to fork. Note that specifying a phase overrides specifying a goal. The specified <code>goal</code> must be
51 * another goal of the same plugin.
52 * @return the goal
53 */
54 @Nonnull
55 String goal() default "";
56
57 /**
58 * Lifecycle id of the lifecycle that defines {@link #phase()}. Only valid in combination with {@link #phase()}. If
59 * not specified, Maven will use the lifecycle of the current build.
60 *
61 * @see <a href="https://maven.apache.org/maven-plugin-api/lifecycle-mappings.html">Lifecycle Mappings</a>
62 * @return the lifecycle id
63 */
64 @Nonnull
65 String lifecycle() default "";
66 }