001 package 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 022 import java.lang.annotation.Documented; 023 import java.lang.annotation.ElementType; 024 import java.lang.annotation.Inherited; 025 import java.lang.annotation.Retention; 026 import java.lang.annotation.RetentionPolicy; 027 import 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 * 034 * @author Olivier Lamy 035 * @since 3.0 036 */ 037 @Documented 038 @Retention( RetentionPolicy.CLASS ) 039 @Target( { ElementType.FIELD } ) 040 @Inherited 041 public @interface Parameter 042 { 043 /** 044 * alias supported to get parameter value. 045 * @return the alias 046 */ 047 String alias() default ""; 048 049 /** 050 * Property to use to retrieve a value. Can come from <code>-D</code> execution, setting properties or pom properties. 051 * @return property name 052 */ 053 String property() default ""; 054 055 /** 056 * parameter default value, eventually containing <code>${...}</code> expressions which will be interpreted at 057 * inject time: see 058 * <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html"> 059 * PluginParameterExpressionEvaluator</a>. 060 * @return the default value 061 */ 062 String defaultValue() default ""; 063 064 /** 065 * is the parameter required? 066 * @return <code>true</code> if the Mojo should fail when the parameter cannot be injected 067 */ 068 boolean required() default false; 069 070 /** 071 * Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified 072 * configuration). This is useful when you want to force the user to use common POM elements rather than plugin 073 * configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you 074 * want the user to modify <code><build><finalName/></build></code> rather than specifying a value 075 * for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a 076 * List-typed parameter which expects items of type Artifact doesn't get a List full of Strings. 077 * 078 * @return <code>true</code> if the user should not be allowed to configure the parameter directly 079 */ 080 boolean readonly() default false; 081 }