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 import org.apache.maven.api.ResolutionScope;
28 import org.apache.maven.api.annotations.Experimental;
29
30 /**
31 * This annotation will mark your class as a Mojo (ie. goal in a Maven plugin).
32 *
33 * @since 4.0
34 */
35 @Experimental
36 @Documented
37 @Retention(RetentionPolicy.CLASS)
38 @Target(ElementType.TYPE)
39 @Inherited
40 public @interface Mojo {
41 /**
42 * goal name (required).
43 * @return the goal name
44 */
45 String name();
46
47 /**
48 * default phase to bind your mojo.
49 * @return the default phase
50 */
51 LifecyclePhase defaultPhase() default LifecyclePhase.NONE;
52
53 /**
54 * the required dependency resolution scope.
55 * @return the required dependency resolution scope
56 */
57 ResolutionScope requiresDependencyResolution() default ResolutionScope.NONE;
58
59 /**
60 * the required dependency collection scope.
61 * @return the required dependency collection scope
62 */
63 ResolutionScope requiresDependencyCollection() default ResolutionScope.NONE;
64
65 /**
66 * your Mojo instantiation strategy. (Only <code>per-lookup</code> and <code>singleton</code> are supported)
67 * @return the instantiation strategy
68 */
69 InstantiationStrategy instantiationStrategy() default InstantiationStrategy.PER_LOOKUP;
70
71 /**
72 * does your mojo requires a project to be executed?
73 * @return requires a project
74 */
75 boolean requiresProject() default true;
76
77 /**
78 * if the Mojo uses the Maven project and its child modules.
79 * @return uses the Maven project and its child modules
80 */
81 boolean aggregator() default false;
82
83 /**
84 * does this Mojo need to be online to be executed?
85 * @return need to be online
86 */
87 boolean requiresOnline() default false;
88
89 /**
90 * configurator bean name.
91 * @return the configurator bean name
92 */
93 String configurator() default "";
94 }