public class RatReportMojo extends AbstractRatMojo implements org.apache.maven.reporting.MavenReport
basedir, ECLIPSE_DEFAULT_EXCLUDES, IDEA_DEFAULT_EXCLUDES, MAVEN_DEFAULT_EXCLUDES| Constructor and Description |
|---|
RatReportMojo() |
| 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.
|
createReport, getConfiguration, getLicenseMatchers, getProject, getResourcespublic void execute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException
execute in interface org.apache.maven.plugin.Mojoorg.apache.maven.plugin.MojoFailureException - An error in the plugin configuration was detected.org.apache.maven.plugin.MojoExecutionException - An error occurred while creating the report.public boolean canGenerateReport()
canGenerateReport in interface org.apache.maven.reporting.MavenReportpublic void generate(org.codehaus.doxia.sink.Sink sink,
Locale locale)
throws org.apache.maven.reporting.MavenReportException
generate in interface org.apache.maven.reporting.MavenReportsink - The doxia sink, kind of a SAX handler.locale - The locale to use for writing the report.org.apache.maven.reporting.MavenReportException - Writing the report failed.public String getCategoryName()
getCategoryName in interface org.apache.maven.reporting.MavenReportMavenReport.CATEGORY_PROJECT_REPORTSpublic String getDescription(Locale locale)
getDescription in interface org.apache.maven.reporting.MavenReportlocale - Requested locale of the bundlepublic String getName(Locale locale)
getName in interface org.apache.maven.reporting.MavenReportlocale - Requested locale of the bundlepublic String getOutputName()
getOutputName in interface org.apache.maven.reporting.MavenReportpublic File getReportOutputDirectory()
getReportOutputDirectory in interface org.apache.maven.reporting.MavenReportpublic boolean isExternalReport()
isExternalReport in interface org.apache.maven.reporting.MavenReportpublic void setReportOutputDirectory(File pOutputDirectory)
setReportOutputDirectory in interface org.apache.maven.reporting.MavenReportpOutputDirectory - Reports target directory.Copyright © 2006-2014 The Apache Software Foundation. All Rights Reserved.