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 to configure your Mojo parameters to be injected by
31 * <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/MavenPluginManager.html">
32 * <code>MavenPluginManager.getConfiguredMojo(...)</code></a>.
33 * <p>
34 * Beans injected into Mojo parameters are prepared by <a href="https://www.eclipse.org/sisu/">Sisu</a> JSR330-based
35 * container: this annotation is only effective on fields of the Mojo class itself, nested bean injection
36 * requires Sisu or JSR330 annotations.
37 *
38 * @author Olivier Lamy
39 * @since 3.0
40 */
41 @Documented
42 @Retention( RetentionPolicy.CLASS )
43 @Target( { ElementType.FIELD } )
44 @Inherited
45 public @interface Parameter
46 {
47 /**
48 * name of the bean property used to get/set the field: by default, field name is used.
49 * @return the name of the bean property
50 */
51 String name() default "";
52
53 /**
54 * alias supported to get parameter value.
55 * @return the alias
56 */
57 String alias() default "";
58
59 /**
60 * Property to use to retrieve a value. Can come from <code>-D</code> execution, setting properties or pom
61 * properties.
62 * @return property name
63 */
64 String property() default "";
65
66 /**
67 * parameter default value, eventually containing <code>${...}</code> expressions which will be interpreted at
68 * inject time: see
69 * <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html">
70 * PluginParameterExpressionEvaluator</a>.
71 * @return the default value
72 */
73 String defaultValue() default "";
74
75 /**
76 * is the parameter required?
77 * @return <code>true</code> if the Mojo should fail when the parameter cannot be injected
78 */
79 boolean required() default false;
80
81 /**
82 * Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified
83 * configuration). This is useful when you want to force the user to use common POM elements rather than plugin
84 * configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you
85 * want the user to modify <code><build><finalName/></build></code> rather than specifying a value
86 * for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a
87 * List-typed parameter which expects items of type Artifact doesn't get a List full of Strings.
88 *
89 * @return <code>true</code> if the user should not be allowed to configure the parameter directly
90 */
91 boolean readonly() default false;
92 }