You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/06/06 03:14:15 UTC
svn commit: r1346694 -
/maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
Author: hboutemy
Date: Wed Jun 6 01:14:15 2012
New Revision: 1346694
URL: http://svn.apache.org/viewvc?rev=1346694&view=rev
Log:
improved javadoc: added evaluation result description
Modified:
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
Modified: maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
URL: http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java?rev=1346694&r1=1346693&r2=1346694&view=diff
==============================================================================
--- maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java (original)
+++ maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java Wed Jun 6 01:14:15 2012
@@ -34,30 +34,33 @@ import org.codehaus.plexus.util.introspe
/**
* Evaluator for plugin parameters expressions. Content surrounded by <code>${</code> and <code>}</code> is evaluated.
- * Recognized values are:<ul>
- * <li><code>localRepository</code></li>
- * <li><code>session</code></li>
- * <li><code>session.*</code> (since Maven 3)</li>
- * <li><code>reactorProjects</code></li>
- * <li><code>mojoExecution</code></li>
- * <li><code>project</code></li>
- * <li><code>executedProject</code></li>
- * <li><code>project.*</code></li>
- * <li><code>pom.*</code> (since Maven 3)</li>
- * <li><code>repositorySystemSession</code> (since Maven 3)</li>
- * <li><code>mojo</code> (since Maven 3)</li>
- * <li><code>mojo.*</code> (since Maven 3)</li>
- * <li><code>plugin</code> (since Maven 3)</li>
- * <li><code>plugin.*</code></li>
- * <li><code>settings</code></li>
- * <li><code>settings.*</code></li>
- * <li><code>basedir</code></li>
- * <li>system properties</li>
- * <li>project properties</li>
- * </ul>
+ * Recognized values are:<table border="1">
+ * <tr><th>expression</th> <th></th> <th>evaluation result</th></tr>
+ * <tr><td><code>session</code></td> <td></td> <td>the actual {@link MavenSession}</td></tr>
+ * <tr><td><code>session.*</code></td> <td>(since Maven 3)</td><td></td></tr>
+ * <tr><td><code>localRepository</code></td> <td></td> <td>{@link MavenSession#getLocalRepository()}</td></tr>
+ * <tr><td><code>reactorProjects</code></td> <td></td> <td>{@link MavenSession#getProjects()}</td></tr>
+ * <tr><td><code>repositorySystemSession</code></td><td> (since Maven 3)</td><td>{@link MavenSession#getRepositorySession()}</td></tr>
+ * <tr><td><code>project</code></td> <td></td> <td>{@link MavenSession#getCurrentProject()}</td></tr>
+ * <tr><td><code>project.*</code></td> <td></td> <td></td></tr>
+ * <tr><td><code>pom.*</code></td> <td>(since Maven 3)</td><td>same as <code>project.*</code></td></tr>
+ * <tr><td><code>executedProject</code></td> <td></td> <td>{@link MavenProject#getExecutionProject()}</td></tr>
+ * <tr><td><code>settings</code></td> <td></td> <td>{@link MavenSession#getSettings()}</td></tr>
+ * <tr><td><code>settings.*</code></td> <td></td> <td></td></tr>
+ * <tr><td><code>basedir</code></td> <td></td> <td>{@link MavenSession#getExecutionRootDirectory()} or <code>System.getProperty( "user.dir" )</code> if null</td></tr>
+ * <tr><td><code>mojoExecution</code></td> <td></td> <td>the actual {@link MojoExecution}</td></tr>
+ * <tr><td><code>mojo</code></td> <td>(since Maven 3)</td><td>same as <code>mojoExecution</code></td></tr>
+ * <tr><td><code>mojo.*</code></td> <td>(since Maven 3)</td><td></td></tr>
+ * <tr><td><code>plugin</code></td> <td>(since Maven 3)</td><td>{@link MojoExecution#getMojoDescriptor()}.{@link MojoDescriptor#getPluginDescriptor() getPluginDescriptor()}</td></tr>
+ * <tr><td><code>plugin.*</code></td> <td></td> <td></td></tr>
+ * <tr><td>system properties</td> <td></td> <td></td></tr>
+ * <tr><td>project properties</td> <td></td> <td></td></tr>
+ * </table>
* <i>Notice:</i> <code>reports</code> was supported in Maven 2.x but was removed in Maven 3
*
* @author Jason van Zyl
+ * @see MavenSession
+ * @see MojoExecution
*/
public class PluginParameterExpressionEvaluator
implements TypeAwareExpressionEvaluator