001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.plugins.annotations;
020
021import java.lang.annotation.Documented;
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Inherited;
024import java.lang.annotation.Retention;
025import java.lang.annotation.RetentionPolicy;
026import java.lang.annotation.Target;
027
028/**
029 * Used to configure your Mojo parameters to be injected by
030 * <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/MavenPluginManager.html">
031 * <code>MavenPluginManager.getConfiguredMojo(...)</code></a>.
032 * <p>
033 * Beans injected into Mojo parameters are prepared by <a href="https://www.eclipse.org/sisu/">Sisu</a> JSR330-based
034 * container: this annotation is only effective on fields of the Mojo class itself, nested bean injection
035 * requires Sisu or JSR330 annotations.
036 *
037 * @author Olivier Lamy
038 * @since 3.0
039 */
040@Documented
041@Retention(RetentionPolicy.CLASS)
042@Target({ElementType.FIELD, ElementType.METHOD})
043@Inherited
044public @interface Parameter {
045    /**
046     * name of the bean property used to get/set the field: by default, field name is used.
047     * @return the name of the bean property
048     */
049    String name() default "";
050
051    /**
052     * alias supported to get parameter value.
053     * @return the alias
054     */
055    String alias() default "";
056
057    /**
058     * Property to use to retrieve a value. Can come from <code>-D</code> execution, setting properties or pom
059     * properties.
060     * @return property name
061     */
062    String property() default "";
063
064    /**
065     * parameter default value, may contain <code>${...}</code> expressions which will be interpreted at
066     * inject time: see
067     * <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html">
068     * PluginParameterExpressionEvaluator</a>.
069     * @return the default value
070     */
071    String defaultValue() default "";
072
073    /**
074     * is the parameter required?
075     * @return <code>true</code> if the Mojo should fail when the parameter cannot be injected
076     */
077    boolean required() default false;
078
079    /**
080     * Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified
081     * configuration). This is useful when you want to force the user to use common POM elements rather than plugin
082     * configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you
083     * want the user to modify <code>&lt;build&gt;&lt;finalName/&gt;&lt;/build&gt;</code> rather than specifying a value
084     * for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a
085     * List-typed parameter which expects items of type Artifact doesn't get a List full of Strings.
086     *
087     * @return <code>true</code> if the user should not be allowed to configure the parameter directly
088     */
089    boolean readonly() default false;
090}