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