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.CLASS)
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 * For custom lifecycle phase ids use {@link #customPhase()} instead.
45 * Only one of {@link #customPhase()} and {@link #phase()} must be set.
46 * @return the phase
47 */
48 @Nonnull
49 LifecyclePhase phase() default LifecyclePhase.NONE;
50
51 /**
52 * Custom lifecycle phase to fork. Note that specifying a phase overrides specifying a goal.
53 * This element should only be used for non-standard phases. For standard phases rather use {@link #phase()}.
54 * Only one of {@link #customPhase()} and {@link #phase()} must be set.
55 * @return the custom phase id
56 */
57 @Nonnull
58 String customPhase() default "";
59
60 /**
61 * Goal to fork. Note that specifying a phase overrides specifying a goal. The specified <code>goal</code> must be
62 * another goal of the same plugin.
63 * @return the goal
64 */
65 @Nonnull
66 String goal() default "";
67
68 /**
69 * Lifecycle id of the lifecycle that defines {@link #phase()}. Only valid in combination with {@link #phase()}. If
70 * not specified, Maven will use the lifecycle of the current build.
71 *
72 * @see <a href="https://maven.apache.org/maven-plugin-api/lifecycle-mappings.html">Lifecycle Mappings</a>
73 * @return the lifecycle id
74 */
75 @Nonnull
76 String lifecycle() default "";
77 }