svn commit: r996503 - /maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml

[be...@apache.org]

Author: bentmann
Date: Mon Sep 13 11:37:27 2010
New Revision: 996503

URL: http://svn.apache.org/viewvc?rev=996503&view=rev
Log:
[MNG-4331] Add new mojo annotation @requiresDependencyCollection to grab dependency tree without files

o Mentioned new anno in Mojo API

Modified:
    maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml

Modified: maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml?rev=996503&r1=996502&r2=996503&view=diff
==============================================================================
--- maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml (original)
+++ maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml Mon Sep 13 11:37:27 2010
@@ -510,6 +510,22 @@ under the License.
           </td>
         </tr>
         <tr>
+          <td>requiresDependencyCollection</td>
+          <td>@requiresDependencyCollection &lt;requiredClassPath&gt;</td>
+          <td>No</td>
+          <td>
+            Flags this mojo as requiring information about the dependencies that would make up the specified class path.
+            As the name suggests, this annotation is similar to <code>@requiresDependencyResolution</code> and supports
+            the same values for <i>&lt;requiredClassPath&gt;</i>. The important difference is that this annotation will
+            not resolve the files for the dependencies, i.e. the artifacts associated with a Maven project can lack a
+            file. As such, this annotation is meant for mojos that only want to analyze the set of transitive
+            dependencies, in particular during early lifecycle phases where full dependency resolution might fail due to
+            projects which haven't been built yet. A mojo may use both this annotation and <code>@requiresDependencyResolution</code>
+            at the same time. The resolution state of any dependency that is collected but not requested to be resolved
+            is undefined. Since Maven 3.0.
+          </td>
+        </tr>
+        <tr>
           <td>requiresDirectInvocation</td>
           <td>@requiresDirectInvocation &lt;true|false&gt;</td>
           <td>No. Default: <code>false</code></td>