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 * This annotation will mark your class as a Mojo (ie. goal in a Maven plugin).
33 * The mojo can be annotated with {@code jakarta.inject.*} annotations.
34 * The {@link Parameter} annotation can be added on fields to inject data
35 * from the plugin configuration or from other components.
36 *
37 * @since 4.0.0
38 */
39 @Experimental
40 @Documented
41 @Retention(RetentionPolicy.RUNTIME)
42 @Target(ElementType.TYPE)
43 @Inherited
44 public @interface Mojo {
45 /**
46 * goal name (required).
47 * @return the goal name
48 */
49 @Nonnull
50 String name();
51
52 /**
53 * default phase to bind your mojo.
54 * @return the default phase
55 */
56 @Nonnull
57 String defaultPhase() default "";
58
59 /**
60 * does your mojo requires a project to be executed?
61 * @return requires a project
62 */
63 boolean projectRequired() default true;
64
65 /**
66 * if the Mojo uses the Maven project and its child modules.
67 * @return uses the Maven project and its child modules
68 */
69 boolean aggregator() default false;
70
71 /**
72 * does this Mojo need to be online to be executed?
73 * @return need to be online
74 */
75 boolean onlineRequired() default false;
76
77 /**
78 * TODO: v4: add a SPI for the configurator
79 * configurator bean name.
80 * @return the configurator bean name
81 */
82 @Nonnull
83 String configurator() default "";
84 }