Package org.nuiton.config.plugin

Class AggregateReportMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.nuiton.config.plugin.AggregateReportMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
@Mojo(name="aggregate-report",
      aggregator=true,
      requiresReports=true,
      requiresDependencyResolution=RUNTIME)
@Execute(phase=COMPILE)
public class AggregateReportMojo
extends org.apache.maven.reporting.AbstractMavenReport
Generates a report for declared application config via the ApplicationConfigProvider mechanism on a aggregate mojo.

For each configuration, you can find all his options and actions.

Since:
3.0
Author:
Tony - dev@tchemit.fr

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected java.lang.String outputEncoding
    Report output encoding.

    Fields inherited from interface org.apache.maven.reporting.MavenReport

    CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

    Fields inherited from interface org.apache.maven.plugin.Mojo

    ROLE

  • Constructor Summary

    Constructors 
    Constructor Description
    AggregateReportMojo()  

  • Method Summary

    Modifier and Type Method Description
    boolean canGenerateReport()  
    protected java.lang.ClassLoader createClassLoader()  
    protected void executeReport​(java.util.Locale locale)  
    java.lang.String getCategoryName()  
    java.lang.String getDescription​(java.util.Locale locale)  
    java.lang.String getName​(java.util.Locale locale)  
    protected java.lang.String getOutputDirectory()  
    java.lang.String getOutputName()  
    protected org.apache.maven.project.MavenProject getProject()  
    protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()  

    Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

    closeReport, execute, generate, generate, generate, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory

    Methods inherited from class org.apache.maven.plugin.AbstractMojo

    getLog, getPluginContext, setLog, setPluginContext

    Methods inherited from class java.lang.Object

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

  • Field Details

    • outputEncoding

      @Parameter(property="config.outputEncoding", defaultValue="${project.reporting.outputEncoding}", required=true) protected java.lang.String outputEncoding
      Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.

  • Constructor Details

  • Method Details

    • createClassLoader

      protected java.lang.ClassLoader createClassLoader() throws org.apache.maven.reporting.MavenReportException
      Throws:
      org.apache.maven.reporting.MavenReportException

    • getOutputName

      public java.lang.String getOutputName()

    • getDescription

      public java.lang.String getDescription​(java.util.Locale locale)

    • getName

      public java.lang.String getName​(java.util.Locale locale)

    • getCategoryName

      public java.lang.String getCategoryName()
      Specified by:
      getCategoryName in interface org.apache.maven.reporting.MavenReport
      Overrides:
      getCategoryName in class org.apache.maven.reporting.AbstractMavenReport

    • canGenerateReport

      public boolean canGenerateReport()
      Specified by:
      canGenerateReport in interface org.apache.maven.reporting.MavenReport
      Overrides:
      canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

    • getSiteRenderer

      protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
      Overrides:
      getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

    • getOutputDirectory

      protected java.lang.String getOutputDirectory()
      Overrides:
      getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

    • getProject

      protected org.apache.maven.project.MavenProject getProject()
      Overrides:
      getProject in class org.apache.maven.reporting.AbstractMavenReport

    • executeReport

      protected void executeReport​(java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException
      Specified by:
      executeReport in class org.apache.maven.reporting.AbstractMavenReport
      Throws:
      org.apache.maven.reporting.MavenReportException