|
||||||||||
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,
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, 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.Mojo
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.public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
public void generate(org.codehaus.doxia.sink.Sink sink, Locale locale) throws org.apache.maven.reporting.MavenReportException
generate
in interface org.apache.maven.reporting.MavenReport
sink
- 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.MavenReport
MavenReport.CATEGORY_PROJECT_REPORTS
public String getDescription(Locale locale)
getDescription
in interface org.apache.maven.reporting.MavenReport
locale
- Requested locale of the bundle
public String getName(Locale locale)
getName
in interface org.apache.maven.reporting.MavenReport
locale
- Requested locale of the bundle
public String getOutputName()
getOutputName
in interface org.apache.maven.reporting.MavenReport
public File getReportOutputDirectory()
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public boolean isExternalReport()
isExternalReport
in interface org.apache.maven.reporting.MavenReport
public void setReportOutputDirectory(File pOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
pOutputDirectory
- Reports target directory.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |