View Javadoc

1   package org.apache.maven.project.interpolation;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.model.Model;
23  import org.apache.maven.project.ProjectBuilderConfiguration;
24  
25  import java.io.File;
26  import java.util.Map;
27  
28  /**
29   * @author jdcasey
30   *         <p/>
31   *         Created on Feb 2, 2005
32   */
33  public interface ModelInterpolator
34  {
35      String DEFAULT_BUILD_TIMESTAMP_FORMAT = "yyyyMMdd-HHmm";
36  
37      String BUILD_TIMESTAMP_FORMAT_PROPERTY = "maven.build.timestamp.format";
38  
39      String ROLE = ModelInterpolator.class.getName();
40  
41      /**
42       * @deprecated Use {@link ModelInterpolator#interpolate(Model, File, ProjectBuilderConfiguration, boolean)} instead.
43       */
44      Model interpolate( Model project, Map<String, ?> context )
45          throws ModelInterpolationException;
46  
47      /**
48       * @deprecated Use {@link ModelInterpolator#interpolate(Model, File, ProjectBuilderConfiguration, boolean)} instead.
49       */
50      Model interpolate( Model model, Map<String, ?> context, boolean strict )
51          throws ModelInterpolationException;
52  
53      Model interpolate( Model model,
54                         File projectDir,
55                         ProjectBuilderConfiguration config,
56                         boolean debugEnabled )
57          throws ModelInterpolationException;
58  
59      String interpolate( String src,
60                          Model model,
61                          File projectDir,
62                          ProjectBuilderConfiguration config,
63                          boolean debugEnabled )
64          throws ModelInterpolationException;
65  }