View Javadoc

1   package org.codehaus.modello.maven;
2   
3   /*
4    * Copyright (c) 2004, Codehaus.org
5    *
6    * Permission is hereby granted, free of charge, to any person obtaining a copy of
7    * this software and associated documentation files (the "Software"), to deal in
8    * the Software without restriction, including without limitation the rights to
9    * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10   * of the Software, and to permit persons to whom the Software is furnished to do
11   * so, subject to the following conditions:
12   *
13   * The above copyright notice and this permission notice shall be included in all
14   * copies or substantial portions of the Software.
15   *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20   * 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
22   * SOFTWARE.
23   */
24  
25  import org.apache.maven.plugins.annotations.Mojo;
26  import org.apache.maven.plugins.annotations.Parameter;
27  import org.codehaus.modello.ModelloParameterConstants;
28  
29  import java.io.File;
30  import java.util.Properties;
31  
32  /**
33   * Creates documentation for the model in xdoc format.
34   *
35   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
36   */
37  @Mojo( name = "xdoc", threadSafe = true )
38  public class ModelloXdocMojo
39      extends AbstractModelloGeneratorMojo
40  {
41      /**
42       * The output directory of the generated documentation.
43       */
44      @Parameter( defaultValue = "${project.build.directory}/generated-site/xdoc", required = true )
45      private File outputDirectory;
46      
47      /**
48       * 
49       * @since 1.0-alpha-21
50       */
51      @Parameter
52      private String xdocFileName;
53  
54      /**
55       * The first version of the model. This is used to decide whether or not
56       * to show the since column. If this is not specified, it defaults to the
57       * version of the model, which in turn means that the since column will not
58       * be shown.
59       *
60       * @since 1.0-alpha-14
61       */
62      @Parameter
63      private String firstVersion;
64  
65      protected String getGeneratorType()
66      {
67          return "xdoc";
68      }
69  
70      protected boolean producesCompilableResult()
71      {
72          return false;
73      }
74  
75      public File getOutputDirectory()
76      {
77          return outputDirectory;
78      }
79  
80      public void setOutputDirectory( File outputDirectory )
81      {
82          this.outputDirectory = outputDirectory;
83      }
84  
85      protected void customizeParameters( Properties parameters )
86      {
87          super.customizeParameters( parameters );
88  
89          // Use version if firstVersion was not specified
90          if ( firstVersion == null )
91          {
92              firstVersion = getVersion();
93          }
94  
95          parameters.put( ModelloParameterConstants.FIRST_VERSION, firstVersion );
96         
97          if ( xdocFileName != null )
98          {
99              parameters.put( ModelloParameterConstants.OUTPUT_XDOC_FILE_NAME, xdocFileName );
100         }
101     }
102 
103     public String getFirstVersion()
104     {
105         return firstVersion;
106     }
107 
108     public void setFirstVersion( String firstVersion )
109     {
110         this.firstVersion = firstVersion;
111     }
112 }