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-changelog-plugin.
29   *
30   * @plexus.component role="org.apache.maven.model.converter.plugins.PluginConfigurationConverter" role-hint="changelog"
31   *
32   * @author Dennis Lundberg
33   * @version $Id: PCCChangelog.java 661727 2008-05-30 14:21:49Z bentmann $
34   */
35  public class PCCChangelog
36      extends AbstractPluginConfigurationConverter
37  {
38      /**
39       * @see AbstractPluginConfigurationConverter#getArtifactId()
40       */
41      public String getArtifactId()
42      {
43          return "maven-changelog-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.changelog.commentFormat", "commentFormat" );
56  
57          addConfigurationChild( configuration, projectProperties, "maven.changelog.dateformat", "dateFormat" );
58  
59          addConfigurationChild( configuration, projectProperties, "maven.changelog.svn.baseurl", "tagBase" );
60  
61          addConfigurationChild( configuration, projectProperties, "maven.changelog.type", "type" );
62  
63          String type = projectProperties.getProperty( "maven.changelog.type" );
64          if ( type != null )
65          {
66              if ( "date".equals( type ) )
67              {
68                  Xpp3Dom dates = new Xpp3Dom( "dates" );
69                  addConfigurationChild( dates, projectProperties, "maven.changelog.date", "date" );
70                  if ( dates.getChildCount() > 0 )
71                  {
72                      configuration.addChild( dates );
73                  }
74              }
75              else if ( "range".equals( type ) )
76              {
77                  addConfigurationChild( configuration, projectProperties, "maven.changelog.range", "range" );
78              }
79              else if ( "tag".equals( type ) )
80              {
81                  Xpp3Dom tags = new Xpp3Dom( "tags" );
82                  addConfigurationChild( tags, projectProperties, "maven.changelog.tag", "tag" );
83                  if ( tags.getChildCount() > 0 )
84                  {
85                      configuration.addChild( tags );
86                  }
87              }
88          }
89  
90          // Only add this if we have any other configuration for the changelog-plugin
91          if ( configuration.getChildCount() > 0 )
92          {
93              // The Maven 1 plugin uses the same outputencoding as the generated documentation.
94              addConfigurationChild( configuration, projectProperties, "maven.docs.outputencoding", "outputEncoding" );
95          }
96      }
97  }