org.apache.maven.plugin
Class PluginParameterExpressionEvaluator

java.lang.Object
  extended by org.apache.maven.plugin.PluginParameterExpressionEvaluator
All Implemented Interfaces:
ExpressionEvaluator, TypeAwareExpressionEvaluator

public class PluginParameterExpressionEvaluator
extends Object
implements TypeAwareExpressionEvaluator

Evaluator for plugin parameters expressions. Content surrounded by ${ and } is evaluated. Recognized values are:

expression evaluation result
session the actual MavenSession
session.* (since Maven 3)
localRepository MavenSession.getLocalRepository()
reactorProjects MavenSession.getProjects()
repositorySystemSession (since Maven 3)MavenSession.getRepositorySession()
project MavenSession.getCurrentProject()
project.*
pom.* (since Maven 3)same as project.*
executedProject MavenProject.getExecutionProject()
settings MavenSession.getSettings()
settings.*
basedir MavenSession.getExecutionRootDirectory() or System.getProperty( "user.dir" ) if null
mojoExecution the actual MojoExecution
mojo (since Maven 3)same as mojoExecution
mojo.* (since Maven 3)
plugin (since Maven 3)MojoExecution.getMojoDescriptor().getPluginDescriptor()
plugin.*
* system properties
* project properties
Notice: reports was supported in Maven 2.x but was removed in Maven 3

Author:
Jason van Zyl
See Also:
MavenSession, MojoExecution

Constructor Summary
PluginParameterExpressionEvaluator(MavenSession session)
           
PluginParameterExpressionEvaluator(MavenSession session, MojoExecution mojoExecution)
           
PluginParameterExpressionEvaluator(MavenSession session, MojoExecution mojoExecution, PathTranslator pathTranslator, Logger logger, MavenProject project, Properties properties)
          Deprecated. 
 
Method Summary
 File alignToBaseDirectory(File file)
           
 Object evaluate(String expr)
           
 Object evaluate(String expr, Class<?> type)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PluginParameterExpressionEvaluator

@Deprecated
public PluginParameterExpressionEvaluator(MavenSession session,
                                                     MojoExecution mojoExecution,
                                                     PathTranslator pathTranslator,
                                                     Logger logger,
                                                     MavenProject project,
                                                     Properties properties)
Deprecated. 


PluginParameterExpressionEvaluator

public PluginParameterExpressionEvaluator(MavenSession session)

PluginParameterExpressionEvaluator

public PluginParameterExpressionEvaluator(MavenSession session,
                                          MojoExecution mojoExecution)
Method Detail

evaluate

public Object evaluate(String expr)
                throws ExpressionEvaluationException
Specified by:
evaluate in interface ExpressionEvaluator
Throws:
ExpressionEvaluationException

evaluate

public Object evaluate(String expr,
                       Class<?> type)
                throws ExpressionEvaluationException
Specified by:
evaluate in interface TypeAwareExpressionEvaluator
Throws:
ExpressionEvaluationException

alignToBaseDirectory

public File alignToBaseDirectory(File file)
Specified by:
alignToBaseDirectory in interface ExpressionEvaluator


Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.