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  import java.util.StringTokenizer;
27  
28  /**
29   * A <code>PluginConfigurationConverter</code> for the maven-pmd-plugin.
30   *
31   * @plexus.component role="org.apache.maven.model.converter.plugins.PluginConfigurationConverter" role-hint="pmd"
32   *
33   * @author Dennis Lundberg
34   * @version $Id: PCCPmd.java 661727 2008-05-30 14:21:49Z bentmann $
35   */
36  public class PCCPmd
37      extends AbstractPluginConfigurationConverter
38  {
39      /**
40       * @see AbstractPluginConfigurationConverter#getArtifactId()
41       */
42      public String getArtifactId()
43      {
44          return "maven-pmd-plugin";
45      }
46  
47      public String getType()
48      {
49          return TYPE_REPORT_PLUGIN;
50      }
51  
52      protected void buildConfiguration( Xpp3Dom configuration, org.apache.maven.model.v3_0_0.Model v3Model,
53                                         Properties projectProperties )
54          throws ProjectConverterException
55      {
56          addConfigurationChild( configuration, projectProperties, "maven.pmd.excludes", "excludes" );
57  
58          addConfigurationChild( configuration, projectProperties, "maven.pmd.failonruleviolation", "failOnViolation" );
59  
60          addConfigurationChild( configuration, projectProperties, "maven.pmd.cpd.minimumtokencount", "minimumTokens" );
61  
62          String rulesetfiles = projectProperties.getProperty( "maven.pmd.rulesetfiles" );
63          if ( rulesetfiles != null )
64          {
65              StringTokenizer tokenizer = new StringTokenizer( rulesetfiles, "," );
66              if ( tokenizer.hasMoreTokens() )
67              {
68                  Xpp3Dom rulesets = new Xpp3Dom( "rulesets" );
69                  while ( tokenizer.hasMoreTokens() )
70                  {
71                      addConfigurationChild( rulesets, "ruleset", translate( tokenizer.nextToken() ) );
72                  }
73                  if ( rulesets.getChildCount() > 0 )
74                  {
75                      configuration.addChild( rulesets );
76                  }
77              }
78          }
79  
80          addConfigurationChild( configuration, projectProperties, "maven.pmd.targetjdk", "targetJdk" );
81      }
82  
83      /**
84       * In the Maven 1 plugin the built-in rulesets where accessed by prefixing
85       * them with "rulesets/", but in the Maven 2 plugin the prefix "/rulesets/"
86       * is used.
87       *
88       * @param mavenOneRuleset A ruleset from the Maven 1 configuration
89       * @return A ruleset suitable for the Maven 2 configuration
90       */
91      private String translate( String mavenOneRuleset )
92      {
93          if ( mavenOneRuleset != null && mavenOneRuleset.startsWith( "rulesets/" ) )
94          {
95              return "/" + mavenOneRuleset;
96          }
97          else
98          {
99              return mavenOneRuleset;
100         }
101     }
102 }