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.apache.maven.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  
      private boolean userDefined  
    • 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, boolean userDefined)  
      MavenReportExecution​(org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, java.lang.ClassLoader classLoader, boolean userDefined)  
      MavenReportExecution​(org.apache.maven.reporting.MavenReport mavenReport)  
    • Field Detail

      • goal

        private final java.lang.String goal
      • plugin

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

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

        private java.lang.ClassLoader classLoader
      • userDefined

        private boolean userDefined
    • 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,
                                    boolean userDefined)
      • MavenReportExecution

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

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

      • canGenerateReport

        public boolean canGenerateReport()
                                  throws org.apache.maven.reporting.MavenReportException
        execute Maven Report's canGenerate() with adequate classloader.
        Returns:
        Maven Report's canGenerate() result
        Throws:
        org.apache.maven.reporting.MavenReportException - if any
      • 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()
      • isUserDefined

        public boolean isUserDefined()
      • setUserDefined

        public void setUserDefined​(boolean userDefined)