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 java.io.File;
26  import java.util.Properties;
27  
28  import org.apache.maven.plugins.annotations.Parameter;
29  import org.codehaus.modello.ModelloParameterConstants;
30  
31  /**
32   * @author Hervé Boutemy
33   */
34  public abstract class AbstractModelloSourceGeneratorMojo
35      extends AbstractModelloGeneratorMojo
36  {
37      /**
38       * The output directory of the generated Java beans.
39       */
40      @Parameter( defaultValue = "${project.build.directory}/generated-sources/modello", required = true )
41      private File outputDirectory;
42  
43      /**
44       * The encoding to use when generating Java source files.
45       *
46       * @since 1.0-alpha-19
47       */
48      @Parameter( property = "encoding", defaultValue = "${project.build.sourceEncoding}" )
49      private String encoding;
50  
51      /**
52       * Generate Java 5 sources, with generic collections.
53       * @since 1.0
54       */
55      @Parameter( property = "useJava5", defaultValue = "false" )
56      private boolean useJava5;
57  
58      /**
59       * Generate DOM content as plexus-utils <code>Xpp3Dom</code> objects instead of <code>org.w3c.dom.Element</code>.
60       * @since 1.6
61       */
62      @Parameter( property = "domAsXpp3", defaultValue = "true" )
63      private boolean domAsXpp3;
64  
65      @Override
66      protected boolean producesCompilableResult()
67      {
68          return true;
69      }
70  
71      public File getOutputDirectory()
72      {
73          return outputDirectory;
74      }
75  
76      public void setOutputDirectory( File outputDirectory )
77      {
78          this.outputDirectory = outputDirectory;
79      }
80  
81      @Override
82      protected void customizeParameters( Properties parameters )
83      {
84          super.customizeParameters( parameters );
85  
86          if ( encoding != null )
87          {
88              parameters.setProperty( ModelloParameterConstants.ENCODING, encoding );
89          }
90  
91          parameters.setProperty( ModelloParameterConstants.USE_JAVA5, Boolean.toString( useJava5 ) );
92  
93          parameters.setProperty( ModelloParameterConstants.DOM_AS_XPP3, Boolean.toString( domAsXpp3 ) );
94      }
95  }