eu.lindenbaum.maven
Class ErlangReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          eu.lindenbaum.maven.ErlangReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

Direct Known Subclasses:

CoverageReport, EDocReport, ProfilingReport

public abstract class ErlangReport
extends org.apache.maven.reporting.AbstractMavenReport

A base class for all MavenReports that need to operate on values provided by the PropertiesImpl bean.

Author:

Tobias Schlager

See Also:

PackagingType, Properties

Field Summary

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

ErlangReport()

Method Summary

boolean	canGenerateReport() Returns whether this report can generate any output.
protected abstract void	execute(org.apache.maven.plugin.logging.Log log, Locale l, Properties p) Will be invoked when AbstractMavenReport.execute() gets invoked on the base class.
protected void	executeReport(Locale locale) Injects the needed Properties into the abstract execute(Log, Locale, Properties) method to be implemented by subclasses.
protected String	getOutputDirectory() This may be overwritten by implementing reports, default return value is the absolute path of AbstractMavenReport.getReportOutputDirectory().
protected org.apache.maven.project.MavenProject	getProject()
protected Properties	getProperties() Returns properties built from the mojo parameters of this report and based on the packaging type of this project.
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()

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

closeReport, execute, generate, generate, generate, getCategoryName, 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

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

getDescription, getName, getOutputName

Constructor Detail

ErlangReport

public ErlangReport()

Method Detail

getProject

protected final org.apache.maven.project.MavenProject getProject()

Specified by:

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

getSiteRenderer

protected final org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

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

getOutputDirectory

protected String getOutputDirectory()

This may be overwritten by implementing reports, default return value is the absolute path of AbstractMavenReport.getReportOutputDirectory().

Specified by:

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

executeReport

protected final void executeReport(Locale locale)
                            throws org.apache.maven.reporting.MavenReportException

Injects the needed Properties into the abstract execute(Log, Locale, Properties) method to be implemented by subclasses.

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getProperties

protected Properties getProperties()

Returns properties built from the mojo parameters of this report and based on the packaging type of this project.

Returns:

properties for this report

execute

protected abstract void execute(org.apache.maven.plugin.logging.Log log,
                                Locale l,
                                Properties p)
                         throws org.apache.maven.plugin.MojoExecutionException,
                                org.apache.maven.plugin.MojoFailureException,
                                org.apache.maven.reporting.MavenReportException

Will be invoked when AbstractMavenReport.execute() gets invoked on the base class.

Parameters:

log - logger to be used for output logging

l - the demanded locale as passed to executeReport(Locale)

p - to be passed by the base class.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

org.apache.maven.reporting.MavenReportException

See Also:

AbstractMavenReport.executeReport(Locale)

canGenerateReport

public final boolean canGenerateReport()

Returns whether this report can generate any output.

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

Overrides:

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

Returns:

true if the project is an Erlang application or library application, false otherwise