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.doxia.siterenderer.DocumentRenderingContext docRenderingContext  
      private org.apache.maven.plugin.logging.Log log  
      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.DocumentRenderingContext docRenderingContext, org.apache.maven.plugin.logging.Log log)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getOutputName()  
      java.lang.String getOutputPath()  
      org.apache.maven.doxia.siterenderer.DocumentRenderingContext getRenderingContext()  
      java.lang.String getReportMojoInfo()  
      boolean isExternalReport()  
      boolean isOverwrite()  
      void renderDocument​(java.io.Writer writer, org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer, 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

      • docRenderingContext

        private final org.apache.maven.doxia.siterenderer.DocumentRenderingContext docRenderingContext

      • 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.DocumentRenderingContext docRenderingContext,
                              org.apache.maven.plugin.logging.Log log)

    • Method Detail

      • renderDocument

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

      • getOutputName

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

      • getOutputPath

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

      • getRenderingContext

        public org.apache.maven.doxia.siterenderer.DocumentRenderingContext 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

      • getReportMojoInfo

        public java.lang.String getReportMojoInfo()