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