You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2011/01/06 23:13:58 UTC
svn commit: r1056100 - in
/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin:
changes/ChangesReportGenerator.java issues/AbstractIssuesReportGenerator.java
Author: dennisl
Date: Thu Jan 6 22:13:57 2011
New Revision: 1056100
URL: http://svn.apache.org/viewvc?rev=1056100&view=rev
Log:
o Refactoring: Extract abstract super class.
Added:
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/AbstractIssuesReportGenerator.java (with props)
Modified:
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java?rev=1056100&r1=1056099&r2=1056100&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java Thu Jan 6 22:13:57 2011
@@ -30,6 +30,7 @@ import java.util.ResourceBundle;
import org.apache.commons.lang.StringUtils;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.util.HtmlTools;
+import org.apache.maven.plugin.issues.AbstractIssuesReportGenerator;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.changes.model.Action;
import org.apache.maven.plugins.changes.model.DueTo;
@@ -41,7 +42,7 @@ import org.apache.maven.plugins.changes.
*
* @version $Id$
*/
-public class ChangesReportGenerator
+public class ChangesReportGenerator extends AbstractIssuesReportGenerator
{
/**
@@ -79,18 +80,8 @@ public class ChangesReportGenerator
/**
* @since 2.4
*/
- private String author;
-
- /**
- * @since 2.4
- */
private boolean escapeHTML;
- /**
- * @since 2.4
- */
- private String title;
-
public ChangesReportGenerator()
{
issueLinksPerSystem = new HashMap();
@@ -561,159 +552,4 @@ public class ChangesReportGenerator
return parseLink;
}
- private void sinkBeginReport( Sink sink, ResourceBundle bundle )
- {
- sink.head();
-
- String title = null;
- if ( this.title != null )
- {
- title = this.title;
- }
- else
- {
- title = bundle.getString( "report.issues.header" );
- }
- sink.title();
- sink.text( title );
- sink.title_();
-
- if ( StringUtils.isNotEmpty( author ) )
- {
- sink.author();
- sink.text( author );
- sink.author_();
- }
-
- sink.head_();
-
- sink.body();
-
- sink.section1();
-
- sinkSectionTitle1Anchor( sink, title, title );
- }
-
- private void sinkCell( Sink sink, String text )
- {
- sink.tableCell();
-
- sink.text( text );
-
- sink.tableCell_();
- }
-
- private void sinkCellLink( Sink sink, String text, String link )
- {
- sink.tableCell();
-
- sinkLink( sink, text, link );
-
- sink.tableCell_();
- }
-
- private void sinkEndReport( Sink sink )
- {
- sink.section1_();
-
- sink.body_();
-
- sink.flush();
-
- sink.close();
- }
-
- private void sinkFigure( Sink sink, String image, String altText )
- {
- sink.figure();
-
- sink.figureGraphics( image );
-
- sink.figureCaption();
-
- sink.text( altText );
-
- sink.figureCaption_();
-
- sink.figure_();
- }
-
- private void sinkHeader( Sink sink, String header )
- {
- sink.tableHeaderCell();
-
- sink.text( header );
-
- sink.tableHeaderCell_();
- }
-
- private void sinkLink( Sink sink, String text, String link )
- {
- sink.link( link );
-
- sink.text( text );
-
- sink.link_();
- }
-
- private void sinkSectionTitle1Anchor( Sink sink, String text, String anchor )
- {
- sink.sectionTitle1();
-
- sink.text( text );
-
- sink.sectionTitle1_();
-
- sink.anchor( HtmlTools.encodeId( anchor ) );
- sink.anchor_();
- }
-
- private void sinkSectionTitle2Anchor( Sink sink, String text, String anchor )
- {
- sink.sectionTitle2();
- sink.text( text );
- sink.sectionTitle2_();
-
- sink.anchor( HtmlTools.encodeId( anchor ) );
- sink.anchor_();
- }
-
- private void sinkShowTypeIcon( Sink sink, String type )
- {
- String image = "";
- String altText = "";
-
- if ( type == null )
- {
- image = "images/icon_help_sml.gif";
- altText = "?";
- }
- else if ( type.equals( "fix" ) )
- {
- image = "images/fix.gif";
- altText = "fix";
- }
- else if ( type.equals( "update" ) )
- {
- image = "images/update.gif";
- altText = "update";
- }
- else if ( type.equals( "add" ) )
- {
- image = "images/add.gif";
- altText = "add";
- }
- else if ( type.equals( "remove" ) )
- {
- image = "images/remove.gif";
- altText = "remove";
- }
-
- sink.tableCell();
-
- sinkFigure( sink, image, altText );
-
- sink.tableCell_();
- }
-
}
Added: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/AbstractIssuesReportGenerator.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/AbstractIssuesReportGenerator.java?rev=1056100&view=auto
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/AbstractIssuesReportGenerator.java (added)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/AbstractIssuesReportGenerator.java Thu Jan 6 22:13:57 2011
@@ -0,0 +1,180 @@
+package org.apache.maven.plugin.issues;
+
+import org.apache.maven.doxia.sink.Sink;
+import org.apache.maven.doxia.util.HtmlTools;
+import org.codehaus.plexus.util.StringUtils;
+
+import java.util.ResourceBundle;
+
+/**
+ * An abstract super class that helps when generating a report on issues.
+ *
+ * @author Dennis Lundberg
+ * @version $Id$
+ * @since 2.4
+ */
+public abstract class AbstractIssuesReportGenerator
+{
+ protected String author;
+
+ protected String title;
+
+ public AbstractIssuesReportGenerator()
+ {
+ }
+
+ protected void sinkBeginReport( Sink sink, ResourceBundle bundle )
+ {
+ sink.head();
+
+ String title = null;
+ if ( this.title != null )
+ {
+ title = this.title;
+ }
+ else
+ {
+ title = bundle.getString( "report.issues.header" );
+ }
+ sink.title();
+ sink.text( title );
+ sink.title_();
+
+ if ( StringUtils.isNotEmpty( author ) )
+ {
+ sink.author();
+ sink.text( author );
+ sink.author_();
+ }
+
+ sink.head_();
+
+ sink.body();
+
+ sink.section1();
+
+ sinkSectionTitle1Anchor( sink, title, title );
+ }
+
+ protected void sinkCell( Sink sink, String text )
+ {
+ sink.tableCell();
+
+ sink.text( text );
+
+ sink.tableCell_();
+ }
+
+ protected void sinkCellLink( Sink sink, String text, String link )
+ {
+ sink.tableCell();
+
+ sinkLink( sink, text, link );
+
+ sink.tableCell_();
+ }
+
+ protected void sinkEndReport( Sink sink )
+ {
+ sink.section1_();
+
+ sink.body_();
+
+ sink.flush();
+
+ sink.close();
+ }
+
+ protected void sinkFigure( Sink sink, String image, String altText )
+ {
+ sink.figure();
+
+ sink.figureGraphics( image );
+
+ sink.figureCaption();
+
+ sink.text( altText );
+
+ sink.figureCaption_();
+
+ sink.figure_();
+ }
+
+ protected void sinkHeader( Sink sink, String header )
+ {
+ sink.tableHeaderCell();
+
+ sink.text( header );
+
+ sink.tableHeaderCell_();
+ }
+
+ protected void sinkLink( Sink sink, String text, String link )
+ {
+ sink.link( link );
+
+ sink.text( text );
+
+ sink.link_();
+ }
+
+ protected void sinkSectionTitle1Anchor( Sink sink, String text, String anchor )
+ {
+ sink.sectionTitle1();
+
+ sink.text( text );
+
+ sink.sectionTitle1_();
+
+ sink.anchor( HtmlTools.encodeId( anchor ) );
+ sink.anchor_();
+ }
+
+ protected void sinkSectionTitle2Anchor( Sink sink, String text, String anchor )
+ {
+ sink.sectionTitle2();
+ sink.text( text );
+ sink.sectionTitle2_();
+
+ sink.anchor( HtmlTools.encodeId( anchor ) );
+ sink.anchor_();
+ }
+
+ protected void sinkShowTypeIcon( Sink sink, String type )
+ {
+ String image = "";
+ String altText = "";
+
+ if ( type == null )
+ {
+ image = "images/icon_help_sml.gif";
+ altText = "?";
+ }
+ else if ( type.equals( "fix" ) )
+ {
+ image = "images/fix.gif";
+ altText = "fix";
+ }
+ else if ( type.equals( "update" ) )
+ {
+ image = "images/update.gif";
+ altText = "update";
+ }
+ else if ( type.equals( "add" ) )
+ {
+ image = "images/add.gif";
+ altText = "add";
+ }
+ else if ( type.equals( "remove" ) )
+ {
+ image = "images/remove.gif";
+ altText = "remove";
+ }
+
+ sink.tableCell();
+
+ sinkFigure( sink, image, altText );
+
+ sink.tableCell_();
+ }
+}
\ No newline at end of file
Propchange: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/AbstractIssuesReportGenerator.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/AbstractIssuesReportGenerator.java
------------------------------------------------------------------------------
svn:keywords = Date Revision Author Id