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 * This annotation will mark your class as a Mojo (ie. goal in a Maven plugin). 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 Mojo 40 { 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 * execution strategy: <code>once-per-session</code> or <code>always</code>. 73 * @return <code>once-per-session</code> or <code>always</code> 74 * 75 * @deprecated unused 76 */ 77 @Deprecated 78 String executionStrategy() default "once-per-session"; 79 80 /** 81 * does your mojo requires a project to be executed? 82 * @return requires a project 83 */ 84 boolean requiresProject() default true; 85 86 /** 87 * does your mojo requires a reporting context to be executed? 88 * @return requires a reporting context 89 * 90 * @deprecated unused 91 */ 92 @Deprecated 93 boolean requiresReports() default false; 94 95 /** 96 * if the Mojo uses the Maven project and its child modules. 97 * @return uses the Maven project and its child modules 98 */ 99 boolean aggregator() default false; 100 101 /** 102 * can this Mojo be invoked directly only? 103 * @return invoked directly only 104 * 105 * @deprecated unused 106 */ 107 @Deprecated 108 boolean requiresDirectInvocation() default false; 109 110 /** 111 * does this Mojo need to be online to be executed? 112 * @return need to be online 113 */ 114 boolean requiresOnline() default false; 115 116 /** 117 * @deprecated unused 118 */ 119 @Deprecated 120 boolean inheritByDefault() default true; 121 122 /** 123 * own configurator class. 124 * @return own configurator class 125 */ 126 String configurator() default ""; 127 128 /** 129 * is your mojo thread safe (since Maven 3.x)? 130 * @return is thread safe 131 */ 132 boolean threadSafe() default false; 133 }