Package org.apache.maven.plugin

Class PluginParameterExpressionEvaluator

java.lang.Object

org.apache.maven.plugin.PluginParameterExpressionEvaluator

All Implemented Interfaces:

org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator, org.codehaus.plexus.component.configurator.expression.TypeAwareExpressionEvaluator

public class PluginParameterExpressionEvaluator
extends Object
implements org.codehaus.plexus.component.configurator.expression.TypeAwareExpressionEvaluator

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

Expression matrix

expression		evaluation result
session		the actual MavenSession
session.*	(since Maven 3)
localRepository		MavenSession.getLocalRepository() DEPRECATED: Avoid use of ArtifactRepository type. If you need access to local repository, switch to '${repositorySystemSession}' expression and get LRM from it instead. See MNG-7706
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.*
*		user properties
*		project properties
*		system 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

Constructors

Constructor	Description
PluginParameterExpressionEvaluator(MavenSession session)
PluginParameterExpressionEvaluator(MavenSession session, MojoExecution mojoExecution)
PluginParameterExpressionEvaluator(MavenSession session, MojoExecution mojoExecution, PathTranslator pathTranslator, org.codehaus.plexus.logging.Logger logger, MavenProject project, Properties properties)	Deprecated.

Method Summary

Modifier and Type	Method	Description
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 Details

PluginParameterExpressionEvaluator

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

Deprecated.

PluginParameterExpressionEvaluator

public PluginParameterExpressionEvaluator(MavenSession session)

PluginParameterExpressionEvaluator

public PluginParameterExpressionEvaluator(MavenSession session,
 MojoExecution mojoExecution)

Method Details

evaluate

public Object evaluate(String expr)
                throws org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException

Specified by:

evaluate in interface org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator

Throws:

org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException

evaluate

public Object evaluate(String expr,
 Class<?> type)
                throws org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException

Specified by:

evaluate in interface org.codehaus.plexus.component.configurator.expression.TypeAwareExpressionEvaluator

Throws:

org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException

alignToBaseDirectory

public File alignToBaseDirectory(File file)

Specified by:

alignToBaseDirectory in interface org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator