org.nuiton.config.plugin

Class ReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.nuiton.config.plugin.ReportMojo

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="report",
      requiresReports=true,
      requiresDependencyResolution=RUNTIME)
public class ReportMojo
extends org.apache.maven.reporting.AbstractMavenReport

Generates a report for declared application config via the ApplicationConfigProvider mechanism.

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 and Description
protected 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 and Description
ReportMojo()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected ClassLoader	createClassLoader()
protected void	executeReport(Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
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 Detail

outputEncoding

@Parameter(property="config.outputEncoding",
           defaultValue="${project.reporting.outputEncoding}",
           required=true)
protected 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 Detail

ReportMojo

public ReportMojo()

Method Detail

createClassLoader

protected ClassLoader createClassLoader()

getOutputName

public String getOutputName()

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getCategoryName

public 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 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(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.reporting.MavenReportException