stephenc
/
maven-plugin-tools
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

copied readonly definition from plugin descriptor's editable (editable = !readonly) 

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1339661 13f79535-47bb-0310-9956-ffa450edef68
master
Herve Boutemy 2012-05-17 15:49:42 +00:00
parent 684e7110b1
commit 5a16d68d60
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java
View File

@ -63,8 +63,14 @@ public @interface Parameter
boolean required() default false;
/**
* ignored...
* @return
* Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified
* configuration). This is useful when you want to force the user to use common POM elements rather than plugin
* configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you
* want the user to modify <code>&lt;build&gt;&lt;finalName/&gt;&lt;/build&gt;</code> rather than specifying a value
* for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a
* List-typed parameter which expects items of type Artifact doesn't get a List full of Strings.
*
* @return <code>true</code> if the user should not be allowed to configure the parameter directly
*/
boolean readonly() default false;
}