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 org.apache.maven.execution.MavenSession;
19  import org.apache.maven.execution.RuntimeInformation;
20  import org.apache.maven.project.MavenProject;
21  
22  import de.smartics.maven.plugin.buildmetadata.common.ScmInfo;
23  
24  /**
25   * Base implementation for {@link MetaDataProvider}s.
26   *
27   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
28   * @version $Revision:591 $
29   */
30  public abstract class AbstractMetaDataProvider implements MetaDataProvider
31  {
32    // ********************************* Fields *********************************
33  
34    // --- constants ------------------------------------------------------------
35  
36    // --- members --------------------------------------------------------------
37  
38    /**
39     * The Maven project.
40     *
41     * @impl The implementation is required to cope with a <code>null</code>
42     *       value.
43     */
44    protected MavenProject project;
45  
46    /**
47     * The Maven session instance.
48     *
49     * @impl The implementation is required to cope with a <code>null</code>
50     *       value.
51     */
52    protected MavenSession session;
53  
54    /**
55     * The runtime information of the Maven instance being executed for the build.
56     *
57     * @impl The implementation is required to cope with a <code>null</code>
58     *       value.
59     */
60    protected RuntimeInformation runtime;
61  
62    /**
63     * Information for the SCM provided to the build plugin.
64     */
65    protected ScmInfo scmInfo;
66  
67    // ****************************** Initializer *******************************
68  
69    // ****************************** Constructors ******************************
70  
71    /**
72     * Default constructor.
73     */
74    protected AbstractMetaDataProvider()
75    {
76    }
77  
78    // ****************************** Inner Classes *****************************
79  
80    // ********************************* Methods ********************************
81  
82    // --- init -----------------------------------------------------------------
83  
84    // --- get&set --------------------------------------------------------------
85  
86    // --- business -------------------------------------------------------------
87  
88    // --- object basics --------------------------------------------------------
89  
90  }