org.apache.rat.mp

Class RatReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.rat.mp.AbstractRatMojo

org.apache.rat.mp.RatReportMojo

All Implemented Interfaces:

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

@Mojo(name="rat",
      requiresDependencyResolution=TEST)
public class RatReportMojo
extends AbstractRatMojo
implements org.apache.maven.reporting.MavenReport

Generates a report with Rat's output.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOT_HTML

Fields inherited from class org.apache.rat.mp.AbstractRatMojo

skip

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
RatReportMojo()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport() Returns, whether the report may be generated.
void	execute() Called from Maven to invoke the plugin.
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale) Writes the report to the Doxia sink.
String	getCategoryName() Returns the reports category name.
String	getDescription(Locale locale) Returns the reports description.
String	getName(Locale locale) Returns the reports name.
String	getOutputName() Returns the reports file name.
File	getReportOutputDirectory() Returns the reports output directory.
boolean	isExternalReport() Returns, whether this is an external report.
void	setReportOutputDirectory(File pOutputDirectory) Sets the reports output directory.

Methods inherited from class org.apache.rat.mp.AbstractRatMojo

createReport, createReport, getConfiguration, getProject, getResources

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

DOT_HTML

public static final String DOT_HTML

See Also:

Constant Field Values

Constructor Detail

RatReportMojo

public RatReportMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Called from Maven to invoke the plugin.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoFailureException - An error in the plugin configuration was detected.

org.apache.maven.plugin.MojoExecutionException - An error occurred while creating the report.

canGenerateReport

public boolean canGenerateReport()

Returns, whether the report may be generated.

Specified by:

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

Returns:

Always true.

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Writes the report to the Doxia sink.

Specified by:

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

Parameters:

sink - The doxia sink, kind of a SAX handler.

locale - The locale to use for writing the report.

Throws:

org.apache.maven.reporting.MavenReportException - Writing the report failed.

getCategoryName

public String getCategoryName()

Returns the reports category name.

Specified by:

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

Returns:

MavenReport.CATEGORY_PROJECT_REPORTS

getDescription

public String getDescription(Locale locale)

Returns the reports description.

Specified by:

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

Parameters:

locale - Requested locale of the bundle

Returns:

Report description, as given by the key "report.rat.description" in the bundle.

getName

public String getName(Locale locale)

Returns the reports name.

Specified by:

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

Parameters:

locale - Requested locale of the bundle

Returns:

Report name, as given by the key "report.rat.name" in the bundle.

getOutputName

public String getOutputName()

Returns the reports file name.

Specified by:

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

Returns:

"rat-report"

getReportOutputDirectory

public File getReportOutputDirectory()

Returns the reports output directory.

Specified by:

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

Returns:

Value of the "outputDirectory" parameter.

isExternalReport

public boolean isExternalReport()

Returns, whether this is an external report.

Specified by:

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

Returns:

Always false.

setReportOutputDirectory

public void setReportOutputDirectory(File pOutputDirectory)

Sets the reports output directory.

Specified by:

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

Parameters:

pOutputDirectory - Reports target directory.