View Javadoc

1   /*
2    * Copyright 2006-2012 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.maven.plugin.buildmetadata.data;
17  
18  import java.util.Properties;
19  
20  import org.apache.maven.plugin.MojoExecutionException;
21  
22  /**
23   * Interface to add build meta data information.
24   *
25   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
26   * @version $Revision:591 $
27   */
28  public interface MetaDataProvider
29  {
30    // ********************************* Fields *********************************
31  
32    // --- constants ------------------------------------------------------------
33  
34    // ****************************** Initializer *******************************
35  
36    // ****************************** Inner Classes *****************************
37  
38    // ********************************* Methods ********************************
39  
40    // --- get&set --------------------------------------------------------------
41  
42    // --- business -------------------------------------------------------------
43  
44    /**
45     * Adds the information as build properties.
46     *
47     * @param buildMetaDataProperties the build meta data properties to add to.
48     * @throws MojoExecutionException on any problem encountered.
49     */
50    void provideBuildMetaData(Properties buildMetaDataProperties)
51      throws MojoExecutionException;
52  
53    // --- object basics --------------------------------------------------------
54  
55  }