org.codehaus.mojo.license

Class AbstractLicenseReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.license.AbstractLicenseReportMojo

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:

ThirdPartyReportMojo

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

Base class for all license reports.

Since:

1.1

Author:

tchemit

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

Constructors

Constructor and Description
AbstractLicenseReportMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink) Generates the report.
protected void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getEncoding()
protected ThirdPartyHelper	getHelper()
org.codehaus.plexus.i18n.I18N	getI18n()
String	getName(Locale locale)
protected String	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
String	getText(Locale locale, String key) Gets the localized message for this report.
abstract boolean	isSkip() When is sets to true, will skip execution.
boolean	isVerbose()

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

canGenerateReport, 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

getOutputName

Constructor Detail

AbstractLicenseReportMojo

public AbstractLicenseReportMojo()

Method Detail

isSkip

public abstract boolean isSkip()

When is sets to true, will skip execution.

This will take effect in at the very begin of the AbstractMavenReport.execute() before any initialisation of goal.

Returns:

true if goal will not be executed

doGenerateReport

protected abstract void doGenerateReport(Locale locale,
                    org.apache.maven.doxia.sink.Sink sink)
                                  throws org.apache.maven.reporting.MavenReportException,
                                         org.apache.maven.plugin.MojoExecutionException,
                                         org.apache.maven.plugin.MojoFailureException

Generates the report.

Parameters:

locale - the locale to generate the report for.

sink - the report formatting tool.

Throws:

org.apache.maven.reporting.MavenReportException - when things go wrong.

org.apache.maven.plugin.MojoExecutionException - when things go wrong.

org.apache.maven.plugin.MojoFailureException - when things go wrong.

getHelper

protected ThirdPartyHelper getHelper()

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

getProject

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

Specified by:

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

getOutputDirectory

protected String getOutputDirectory()

Specified by:

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

getSiteRenderer

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

Specified by:

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

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getText

public String getText(Locale locale,
             String key)

Gets the localized message for this report.

Parameters:

locale - the locale.

key - the message key.

Returns:

the message.

getI18n

public org.codehaus.plexus.i18n.I18N getI18n()

isVerbose

public boolean isVerbose()

getEncoding

public final String getEncoding()