Class MavenReportExecution


  • public class MavenReportExecution
    extends java.lang.Object

    Since Maven 3, reporting plugins (ie MavenReports) are not anymore prepared by Maven core. This class will store all necessary information for later MavenReport generation/execution:

    • a MavenReport,
    • the goal name associated to the report,
    • the associated ClassLoader for the report generation,
    • the Plugin associated to the MavenReport.

    With this bean, a plugin wanting to generate a report (= "execute" the report) has to call the MavenReport#generate(org.codehaus.doxia.sink.Sink, java.util.Locale) method, setting the current Thread classLoader first with classLoader.

    This bean is instantiated by MavenReportExecutor.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.ClassLoader classLoader  
      private java.lang.String goal  
      private org.apache.maven.reporting.MavenReport mavenReport  
      private org.apache.maven.model.Plugin plugin  
    • Constructor Summary

      Constructors 
      Constructor Description
      MavenReportExecution​(java.lang.String goal, org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, java.lang.ClassLoader classLoader)  
      MavenReportExecution​(org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, java.lang.ClassLoader classLoader)  
      MavenReportExecution​(org.apache.maven.reporting.MavenReport mavenReport)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canGenerateReport()
      execute Maven Report's canGenerate() with adequate classloader.
      java.lang.ClassLoader getClassLoader()  
      java.lang.String getGoal()  
      org.apache.maven.reporting.MavenReport getMavenReport()  
      org.apache.maven.model.Plugin getPlugin()  
      void setClassLoader​(java.lang.ClassLoader classLoader)  
      void setMavenReport​(org.apache.maven.reporting.MavenReport mavenReport)  
      void setPlugin​(org.apache.maven.model.Plugin plugin)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • mavenReport

        private org.apache.maven.reporting.MavenReport mavenReport
      • classLoader

        private java.lang.ClassLoader classLoader
      • plugin

        private org.apache.maven.model.Plugin plugin
      • goal

        private final java.lang.String goal
    • Constructor Detail

      • MavenReportExecution

        public MavenReportExecution​(java.lang.String goal,
                                    org.apache.maven.model.Plugin plugin,
                                    org.apache.maven.reporting.MavenReport mavenReport,
                                    java.lang.ClassLoader classLoader)
      • MavenReportExecution

        public MavenReportExecution​(org.apache.maven.model.Plugin plugin,
                                    org.apache.maven.reporting.MavenReport mavenReport,
                                    java.lang.ClassLoader classLoader)
      • MavenReportExecution

        public MavenReportExecution​(org.apache.maven.reporting.MavenReport mavenReport)
    • Method Detail

      • canGenerateReport

        public boolean canGenerateReport()
        execute Maven Report's canGenerate() with adequate classloader.
        Returns:
        Maven Report's canGenerate() result
      • getMavenReport

        public org.apache.maven.reporting.MavenReport getMavenReport()
      • setMavenReport

        public void setMavenReport​(org.apache.maven.reporting.MavenReport mavenReport)
      • getClassLoader

        public java.lang.ClassLoader getClassLoader()
      • setClassLoader

        public void setClassLoader​(java.lang.ClassLoader classLoader)
      • setPlugin

        public void setPlugin​(org.apache.maven.model.Plugin plugin)
      • getPlugin

        public org.apache.maven.model.Plugin getPlugin()
      • getGoal

        public java.lang.String getGoal()