org.apache.maven.model.interpolation
Interface ModelInterpolator

All Known Implementing Classes:

AbstractStringBasedModelInterpolator, StringSearchModelInterpolator

public interface ModelInterpolator

Replaces expressions of the form ${token} with their effective values. Effective values are basically calculated from the elements of the model itself and the execution properties from the building request.

Author:

jdcasey

Created on Feb 2, 2005

interpolateModel

Model interpolateModel(Model model,
                       File projectDir,
                       ModelBuildingRequest request,
                       ModelProblemCollector problems)

Interpolates expressions in the specified model. Note that implementations are free to either interpolate the provided model directly or to create a clone of the model and interpolate the clone. Callers should always use the returned model and must not rely on the input model being updated.

Parameters:

model - The model to interpolate, must not be null.

projectDir - The project directory, may be null if the model does not belong to a local project but to some artifact's metadata.

request - The model building request that holds further settings, must not be null.

problems - The container used to collect problems that were encountered, must not be null.

Returns:

The interpolated model, never null.