View Javadoc

1   package org.apache.maven.model.converter.plugins;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.model.converter.ProjectConverterException;
23  import org.codehaus.plexus.util.xml.Xpp3Dom;
24  
25  import java.util.Properties;
26  
27  /**
28   * A <code>PluginConfigurationConverter</code> for the maven-checkstyle-plugin.
29   *
30   * @plexus.component role="org.apache.maven.model.converter.plugins.PluginConfigurationConverter" role-hint="checkstyle"
31   *
32   * @author Dennis Lundberg
33   * @version $Id: PCCCheckstyle.java 661727 2008-05-30 14:21:49Z bentmann $
34   */
35  public class PCCCheckstyle
36      extends AbstractPluginConfigurationConverter
37  {
38      /**
39       * @see AbstractPluginConfigurationConverter#getArtifactId()
40       */
41      public String getArtifactId()
42      {
43          return "maven-checkstyle-plugin";
44      }
45  
46      public String getType()
47      {
48          return TYPE_REPORT_PLUGIN;
49      }
50  
51      protected void buildConfiguration( Xpp3Dom configuration, org.apache.maven.model.v3_0_0.Model v3Model,
52                                         Properties projectProperties )
53          throws ProjectConverterException
54      {
55          addConfigurationChild( configuration, projectProperties, "maven.checkstyle.cache.file", "cacheFile" );
56  
57          String format = projectProperties.getProperty( "maven.checkstyle.format" );
58          if ( format != null )
59          {
60              String mavenTwoformat = null;
61              if ( format.equals( "avalon" ) )
62              {
63                  mavenTwoformat = "config/avalon_checks.xml";
64              }
65              else if ( format.equals( "turbine" ) )
66              {
67                  mavenTwoformat = "config/turbine_checks.xml";
68              }
69              else if ( format.equals( "sun" ) )
70              {
71                  mavenTwoformat = "config/sun_checks.xml";
72              }
73              if ( mavenTwoformat != null )
74              {
75                  addConfigurationChild( configuration, "configLocation", mavenTwoformat );
76              }
77          }
78          else
79          {
80              String propertiesURL = projectProperties.getProperty( "maven.checkstyle.propertiesURL" );
81              if ( propertiesURL != null )
82              {
83                  addConfigurationChild( configuration, "configLocation", propertiesURL );
84              }
85              else
86              {
87                  addConfigurationChild( configuration, projectProperties, "maven.checkstyle.properties",
88                                         "configLocation" );
89              }
90          }
91  
92          addConfigurationChild( configuration, projectProperties, "maven.checkstyle.excludes", "excludes" );
93  
94          addConfigurationChild( configuration, projectProperties, "maven.checkstyle.fail.on.violation", "failsOnError" );
95  
96          addConfigurationChild( configuration, projectProperties, "maven.checkstyle.header.file", "headerLocation" );
97  
98          addConfigurationChild( configuration, projectProperties, "maven.checkstyle.includes", "includes" );
99  
100         String outputText = projectProperties.getProperty( "maven.checkstyle.output.txt" );
101         if ( outputText != null )
102         {
103             addConfigurationChild( configuration, "outputFile", outputText );
104             addConfigurationChild( configuration, "outputFileFormat", "plain" );
105         }
106         else
107         {
108             String outputXml = projectProperties.getProperty( "maven.checkstyle.output.xml" );
109             if ( outputXml != null )
110             {
111                 addConfigurationChild( configuration, "outputFile", outputXml );
112                 addConfigurationChild( configuration, "outputFileFormat", "xml" );
113             }
114         }
115 
116         addConfigurationChild( configuration, projectProperties, "maven.checkstyle.suppressions.file",
117                                "suppressionsLocation" );
118 
119         addConfigurationChild( configuration, projectProperties, "maven.checkstyle.usefile", "useFile" );
120     }
121 }