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