|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.rat.mp.AbstractRatMojo
org.apache.rat.mp.RatReportMojo
public class RatReportMojo
Generates a report with RAT's output.
| Field Summary |
|---|
| Fields inherited from class org.apache.rat.mp.AbstractRatMojo |
|---|
basedir, ECLIPSE_DEFAULT_EXCLUDES, IDEA_DEFAULT_EXCLUDES, MAVEN_DEFAULT_EXCLUDES |
| 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 | |
|---|---|
RatReportMojo()
|
|
| Method Summary | |
|---|---|
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,
java.util.Locale locale)
Writes the report to the Doxia sink. |
java.lang.String |
getCategoryName()
Returns the reports category name. |
java.lang.String |
getDescription(java.util.Locale locale)
Returns the reports description. |
java.lang.String |
getName(java.util.Locale locale)
Returns the reports name. |
java.lang.String |
getOutputName()
Returns the reports file name. |
java.io.File |
getReportOutputDirectory()
Returns the reports output directory. |
boolean |
isExternalReport()
Returns, whether this is an external report. |
void |
setReportOutputDirectory(java.io.File pOutputDirectory)
Sets the reports output directory. |
| Methods inherited from class org.apache.rat.mp.AbstractRatMojo |
|---|
createReport, getConfiguration, getLicenseMatchers, 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 |
| Constructor Detail |
|---|
public RatReportMojo()
| Method Detail |
|---|
public 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.MavenReport
public void generate(org.codehaus.doxia.sink.Sink sink,
java.util.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 java.lang.String getCategoryName()
getCategoryName in interface org.apache.maven.reporting.MavenReportMavenReport.CATEGORY_PROJECT_REPORTSpublic java.lang.String getDescription(java.util.Locale locale)
getDescription in interface org.apache.maven.reporting.MavenReportlocale - Requested locale of the bundle
public java.lang.String getName(java.util.Locale locale)
getName in interface org.apache.maven.reporting.MavenReportlocale - Requested locale of the bundle
public java.lang.String getOutputName()
getOutputName in interface org.apache.maven.reporting.MavenReportpublic java.io.File getReportOutputDirectory()
getReportOutputDirectory in interface org.apache.maven.reporting.MavenReportpublic boolean isExternalReport()
isExternalReport in interface org.apache.maven.reporting.MavenReportpublic void setReportOutputDirectory(java.io.File pOutputDirectory)
setReportOutputDirectory in interface org.apache.maven.reporting.MavenReportpOutputDirectory - Reports target directory.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||