Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

o Added some API docs 

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@781127 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benjamin Bentmann 2009-06-02 19:10:40 +00:00
parent 99a0a12c46
commit a47090cd84
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
maven-model-builder/src/main/java/org/apache/maven/model/interpolation/ModelInterpolator.java
View File

@ -25,6 +25,9 @@ import org.apache.maven.model.ModelBuildingRequest;
import java.io.File;
/**
* Replaces expressions of the form <tt>${token}</tt> 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
* <p/>
* Created on Feb 2, 2005
@ -32,10 +35,30 @@ import java.io.File;
public interface ModelInterpolator
{
/**
* The default format used for build timestamps.
*/
String DEFAULT_BUILD_TIMESTAMP_FORMAT = "yyyyMMdd-HHmm";
/**
* The name of a property that if present in the model's {@code <properties>} section specifies a custom format for
* build timestamps. See {@link java.text.SimpleDateFormat} for details on the format.
*/
String BUILD_TIMESTAMP_FORMAT_PROPERTY = "maven.build.timestamp.format";
/**
* 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.
*
* @param model The model to interpolate, must not be {@code null}.
* @param projectDir The project directory, may be {@code null} if the model does not belong to a local project but
* to some artifact's metadata.
* @param request The model building request that holds further settings, must not be {@code null}.
* @return The interpolated model, never {@code null}.
* @throws ModelInterpolationException If the model could not be interpolated (e.g. due to expressions with cyclic
* references).
*/
Model interpolateModel( Model model, File projectDir, ModelBuildingRequest request )
throws ModelInterpolationException;