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 java.lang.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()
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

See Also:

MavenSession, MojoExecution

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	basedir
private MojoExecution	mojoExecution
private MavenProject	project
private java.util.Properties	properties
private MavenSession	session

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, java.util.Properties properties)	Deprecated.

Method Summary

Modifier and Type	Method	Description
java.io.File	alignToBaseDirectory(java.io.File file)
java.lang.Object	evaluate(java.lang.String expr)
java.lang.Object	evaluate(java.lang.String expr, java.lang.Class<?> type)
private static boolean	isTypeCompatible(java.lang.Class<?> type, java.lang.Object value)
private java.lang.String	stripTokens(java.lang.String expr)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

session

private MavenSession session

mojoExecution

private MojoExecution mojoExecution

project

private MavenProject project

basedir

private java.lang.String basedir

properties

private java.util.Properties properties

Constructor Detail

PluginParameterExpressionEvaluator

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

Deprecated.

PluginParameterExpressionEvaluator

public PluginParameterExpressionEvaluator(MavenSession session)

PluginParameterExpressionEvaluator

public PluginParameterExpressionEvaluator(MavenSession session,
                                          MojoExecution mojoExecution)

Method Detail

evaluate

public java.lang.Object evaluate(java.lang.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 java.lang.Object evaluate(java.lang.String expr,
                                 java.lang.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

isTypeCompatible

private static boolean isTypeCompatible(java.lang.Class<?> type,
                                        java.lang.Object value)

stripTokens

private java.lang.String stripTokens(java.lang.String expr)

alignToBaseDirectory

public java.io.File alignToBaseDirectory(java.io.File file)

Specified by:

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