From 5a16d68d60559270821e96ece4bc667960641634 Mon Sep 17 00:00:00 2001 From: Herve Boutemy Date: Thu, 17 May 2012 15:49:42 +0000 Subject: [PATCH] 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 --- .../apache/maven/plugins/annotations/Parameter.java | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java b/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java index ccad355..1acd632 100644 --- a/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java +++ b/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java @@ -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 <build><finalName/></build> 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 true if the user should not be allowed to configure the parameter directly */ boolean readonly() default false; }