View Javadoc
1   package org.codehaus.plexus.maven.plugin;
2   
3   /*
4    * The MIT License
5    * 
6    * Copyright (c) 2004-2006, The Codehaus
7    * 
8    * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
9    * associated documentation files (the "Software"), to deal in the Software without restriction,
10   * including without limitation the rights to use, copy, modify, merge, publish, distribute,
11   * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
12   * furnished to do so, subject to the following conditions:
13   * 
14   * The above copyright notice and this permission notice shall be included in all copies or
15   * substantial portions of the Software.
16   * 
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
18   * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19   * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22   */
23  
24  import org.apache.maven.plugin.AbstractMojo;
25  import org.apache.maven.project.MavenProject;
26  import org.apache.maven.project.MavenProjectHelper;
27  import org.codehaus.plexus.metadata.MetadataGenerator;
28  
29  /**
30   * Base class for Plexus Metadata mojos.
31   *
32   * @author Jason van Zyl
33   */
34  public abstract class AbstractDescriptorMojo
35      extends AbstractMojo
36  {
37  
38      /**
39       * Current project
40       *
41       * @parameter default-value="${project}"
42       * @required
43       * @readonly
44       */
45      protected MavenProject mavenProject;
46  
47      /**
48       * The file encoding of the source files.
49       * 
50       * @parameter default-value="${project.build.sourceEncoding}"
51       */
52      protected String sourceEncoding;
53  
54      /** @component */
55      protected MavenProjectHelper mavenProjectHelper;
56  
57      /** @component */
58      protected MetadataGenerator metadataGenerator;
59  
60  }