Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improved javadoc: added evaluation result description 

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-3/trunk@1346694 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Herve Boutemy 2012-06-06 01:14:15 +00:00
parent 953a7f43aa
commit 2f6cc7d2d5
1 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
View File

@ -34,30 +34,33 @@ import org.codehaus.plexus.util.introspection.ReflectionValueExtractor;
/**
* 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