Author: hboutemy
Date: Fri Sep 2 22:50:23 2011
New Revision: 1164753
URL: http://svn.apache.org/viewvc?rev=1164753&view=rev
Log:
improved javadoc and source demo
Added:
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/DemoReportRenderer.java
(with props)
Modified:
maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReportRenderer.java
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/AbstractMavenReportTest.java
Modified:
maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReportRenderer.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReportRenderer.java?rev=1164753&r1=1164752&r2=1164753&view=diff
==============================================================================
---
maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReportRenderer.java
(original)
+++
maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReportRenderer.java
Fri Sep 2 22:50:23 2011
@@ -35,7 +35,8 @@ import java.util.Map;
import java.util.Properties;
/**
- * An abstract class to manage report generation.
+ * An abstract class to manage report generation, with many helper methods to
ease the job: you just need to
+ * implement getTitle() and renderBody().
*
* @author <a href="mailto:ja...@maven.org";>Jason van Zyl</a>
* @author <a href="eveni...@apache.org">Emmanuel Venisse</a>
@@ -45,6 +46,8 @@ import java.util.Properties;
* @TODO Later it may be appropriate to create something like a
VelocityMavenReportRenderer
* that could take a velocity template and pipe that through Doxia rather than
coding them
* up like this.
+ * @see #getTitle()
+ * @see #renderBody()
*/
public abstract class AbstractMavenReportRenderer
implements MavenReportRenderer
Modified:
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/AbstractMavenReportTest.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/AbstractMavenReportTest.java?rev=1164753&r1=1164752&r2=1164753&view=diff
==============================================================================
---
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/AbstractMavenReportTest.java
(original)
+++
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/AbstractMavenReportTest.java
Fri Sep 2 22:50:23 2011
@@ -97,8 +97,12 @@ public class AbstractMavenReportTest
protected void executeReport( Locale locale )
throws MavenReportException
{
- getSink().body();
+ // direct report generation
+ /*getSink().body();
getSink().text( "Abstract Maven Report Test Content" );
- getSink().body_();
+ getSink().body_();*/
+
+ // use a AbstractMavenReportRenderer subclass
+ MavenReportRenderer r = new DemoReportRenderer( getSink() );
}
}
Added:
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/DemoReportRenderer.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/DemoReportRenderer.java?rev=1164753&view=auto
==============================================================================
---
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/DemoReportRenderer.java
(added)
+++
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/DemoReportRenderer.java
Fri Sep 2 22:50:23 2011
@@ -0,0 +1,47 @@
+package org.apache.maven.reporting;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.maven.doxia.sink.Sink;
+
+public class DemoReportRenderer
+ extends AbstractMavenReportRenderer
+{
+
+ public DemoReportRenderer( Sink sink )
+ {
+ super( sink );
+ }
+
+ public String getTitle()
+ {
+ return "report title";
+ }
+
+ public void renderBody()
+ {
+ startSection( "section" );
+
+ text( "demo" );
+
+ endSection();
+ }
+
+}
Propchange:
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/DemoReportRenderer.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/DemoReportRenderer.java
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange:
maven/shared/trunk/maven-reporting-impl/src/test/java/org/apache/maven/reporting/DemoReportRenderer.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
