Package org.apache.maven.api.services

Interface ModelTransformerContext

public interface ModelTransformerContext

Context used to transform a pom file.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final Object	KEY	Key to get the TransformerContext from the SessionData

Method Summary

Modifier and Type	Method	Description
Model	getRawModel(Path from, String groupId, String artifactId)	Get the model from the reactor based on the groupId and artifactId when resolving reactor dependencies.
Model	getRawModel(Path from, Path pomFile)	Get the model based on the path when resolving the parent based on relativePath.
String	getUserProperty(String key)	Get the value of the Maven user property.
Path	locate(Path path)	Locate the POM file inside the given directory.

Field Details

KEY

static final Object KEY

Key to get the TransformerContext from the SessionData

Method Details

getUserProperty

String getUserProperty(String key)

Get the value of the Maven user property.

getRawModel

Model getRawModel(Path from,
 Path pomFile)

Get the model based on the path when resolving the parent based on relativePath.

Parameters:

from - the requiring model

pomFile - the path to the pomFile

Returns:

the model, otherwise null

getRawModel

Model getRawModel(Path from,
 String groupId,
 String artifactId)

Get the model from the reactor based on the groupId and artifactId when resolving reactor dependencies.

Parameters:

from - the requiring model

groupId - the groupId

artifactId - the artifactId

Returns:

the model, otherwise null

Throws:

IllegalStateException - if multiple versions of the same GA are part of the reactor

locate

Path locate(Path path)

Locate the POM file inside the given directory.