1 package org.apache.maven.plugins.annotations;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.lang.annotation.Documented;
23 import java.lang.annotation.ElementType;
24 import java.lang.annotation.Inherited;
25 import java.lang.annotation.Retention;
26 import java.lang.annotation.RetentionPolicy;
27 import java.lang.annotation.Target;
28
29 /**
30 * Used if your Mojo needs to fork a <a href="/ref/3.0.4/maven-core/lifecycles.html">lifecycle</a>.
31 *
32 * @author Olivier Lamy
33 * @since 3.0
34 */
35 @Documented
36 @Retention( RetentionPolicy.CLASS )
37 @Target( ElementType.TYPE )
38 @Inherited
39 public @interface Execute
40 {
41 /**
42 * lifecycle phase to fork. Note that specifying a phase overrides specifying a goal.
43 * @return the phase
44 */
45 LifecyclePhase phase() default LifecyclePhase.NONE;
46
47 /**
48 * goal to fork. Note that specifying a phase overrides specifying a goal. The specified <code>goal</code> must be
49 * another goal of the same plugin.
50 * @return the goal
51 */
52 String goal() default "";
53
54 /**
55 * lifecycle id of the lifecycle that defines {@link #phase()}. Only valid in combination with {@link #phase()}. If
56 * not specified, Maven will use the lifecycle of the current build.
57 *
58 * @see <a href="https://maven.apache.org/maven-plugin-api/lifecycle-mappings.html">Lifecycle Mappings</a>
59 * @return the lifecycle id
60 */
61 String lifecycle() default "";
62 }