Package org.apache.maven.plugins.site.render

Class ReportDocumentRenderer

  • All Implemented Interfaces:
    org.apache.maven.doxia.siterenderer.DocumentRenderer
    public class ReportDocumentRenderer
extends java.lang.Object
implements org.apache.maven.doxia.siterenderer.DocumentRenderer
    Renders a Maven report in a Doxia site.
    See Also:
    DoxiaDocumentRenderer

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.ClassLoader classLoader  
      private org.apache.maven.plugin.logging.Log log  
      private org.apache.maven.doxia.siterenderer.RenderingContext renderingContext  
      private org.apache.maven.reporting.MavenReport report  
      private java.lang.String reportMojoInfo  

    • Constructor Summary

      Constructors 
      Constructor Description
      ReportDocumentRenderer​(org.apache.maven.reporting.exec.MavenReportExecution mavenReportExecution, org.apache.maven.doxia.siterenderer.RenderingContext renderingContext, org.apache.maven.plugin.logging.Log log)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private boolean generateMultiPage​(java.util.Locale locale, org.apache.maven.doxia.sink.SinkFactory sf, org.apache.maven.doxia.sink.Sink sink)
      Try to generate report with extended multi-page API.
      java.lang.String getOutputName()  
      private java.lang.String getPluginInfo​(org.apache.maven.reporting.MavenReport report)
      Get plugin information from report's Manifest.
      org.apache.maven.doxia.siterenderer.RenderingContext getRenderingContext()  
      boolean isExternalReport()  
      boolean isOverwrite()  
      void renderDocument​(java.io.Writer writer, org.apache.maven.doxia.siterenderer.Renderer renderer, org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • report

        private final org.apache.maven.reporting.MavenReport report

      • renderingContext

        private final org.apache.maven.doxia.siterenderer.RenderingContext renderingContext

      • reportMojoInfo

        private final java.lang.String reportMojoInfo

      • classLoader

        private final java.lang.ClassLoader classLoader

      • log

        private final org.apache.maven.plugin.logging.Log log

    • Constructor Detail

      • ReportDocumentRenderer

        public ReportDocumentRenderer​(org.apache.maven.reporting.exec.MavenReportExecution mavenReportExecution,
                              org.apache.maven.doxia.siterenderer.RenderingContext renderingContext,
                              org.apache.maven.plugin.logging.Log log)

    • Method Detail

      • getPluginInfo

        private java.lang.String getPluginInfo​(org.apache.maven.reporting.MavenReport report)
        Get plugin information from report's Manifest.
        Parameters:
        report - the Maven report
        Returns:
        plugin information as Specification Title followed by Specification Version if set in Manifest and supported by JVM

      • renderDocument

        public void renderDocument​(java.io.Writer writer,
                           org.apache.maven.doxia.siterenderer.Renderer renderer,
                           org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext)
                    throws org.apache.maven.doxia.siterenderer.RendererException,
                           java.io.FileNotFoundException
        Specified by:
        renderDocument in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
        Throws:
        org.apache.maven.doxia.siterenderer.RendererException
        java.io.FileNotFoundException

      • generateMultiPage

        private boolean generateMultiPage​(java.util.Locale locale,
                                  org.apache.maven.doxia.sink.SinkFactory sf,
                                  org.apache.maven.doxia.sink.Sink sink)
                           throws org.apache.maven.reporting.MavenReportException
        Try to generate report with extended multi-page API.
        Returns:
        true if the report was compatible with the extended API
        Throws:
        org.apache.maven.reporting.MavenReportException

      • getOutputName

        public java.lang.String getOutputName()
        Specified by:
        getOutputName in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

      • getRenderingContext

        public org.apache.maven.doxia.siterenderer.RenderingContext getRenderingContext()
        Specified by:
        getRenderingContext in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

      • isOverwrite

        public boolean isOverwrite()
        Specified by:
        isOverwrite in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

      • isExternalReport

        public boolean isExternalReport()
        Specified by:
        isExternalReport in interface org.apache.maven.doxia.siterenderer.DocumentRenderer
        Returns:
        true if the current report is external, false otherwise