@Mojo(name="rat", requiresDependencyResolution=TEST, threadSafe=true) public class RatReportMojo extends AbstractRatMojo implements org.apache.maven.reporting.MavenMultiPageReport
Modifier and Type | Field and Description |
---|---|
protected File |
outputDirectory
The output directory for the report.
|
protected List<org.apache.maven.artifact.repository.ArtifactRepository> |
remoteRepositories
Remote repositories used for the project.
|
protected org.apache.maven.execution.MavenSession |
session
The local repository.
|
protected org.apache.maven.doxia.siterenderer.Renderer |
siteRenderer
Doxia Site Renderer component.
|
protected org.apache.maven.doxia.tools.SiteTool |
siteTool
SiteTool.
|
project, skip
args
Constructor and Description |
---|
RatReportMojo() |
Modifier and Type | Method and Description |
---|---|
boolean |
canGenerateReport() |
protected void |
closeReport()
Actions when closing the report.
|
void |
execute()
This method is called when the report generation is invoked directly as a
standalone Mojo.
|
protected void |
executeReport(Locale locale)
Writes the report to the Doxia sink.
|
void |
generate(org.codehaus.doxia.sink.Sink sink,
Locale locale)
Deprecated.
use
generate(Sink, SinkFactory, Locale) instead. |
void |
generate(org.apache.maven.doxia.sink.Sink sink,
Locale locale)
Deprecated.
use
generate(Sink, SinkFactory, Locale) instead. |
void |
generate(org.apache.maven.doxia.sink.Sink sink,
org.apache.maven.doxia.sink.SinkFactory sinkFactory,
Locale locale)
This method is called when the report generation is invoked by
maven-site-plugin.
|
String |
getCategoryName() |
String |
getDescription(Locale locale)
Returns the reports description.
|
protected String |
getInputEncoding()
Gets the input files encoding.
|
String |
getName(Locale locale)
Returns the reports name.
|
protected String |
getOutputDirectory() |
protected String |
getOutputEncoding()
Gets the effective reporting output files encoding.
|
String |
getOutputName()
Returns the reports file name.
|
File |
getReportOutputDirectory() |
org.apache.maven.doxia.sink.Sink |
getSink() |
org.apache.maven.doxia.sink.SinkFactory |
getSinkFactory() |
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer() |
boolean |
isExternalReport() |
void |
setReportOutputDirectory(File reportOutputDirectory) |
getConfiguration, getDefaultsBuilder, getProject, getValues, logLicenses, removeKey, setAddDefaultLicenses
addArg, addArg, args, createName, getArg, removeArg, setAddLicense, setArg, setConfig, setConfigs, setConfigurationNoDefaults, setCopyright, setDryRun, setEditCopyright, setEditLicense, setEditOverwrite, setExclude, setExcludeFile, setExcludes, setForce, setHelpLicenses, setInputExclude, setInputExcludeFile, setInputExcludes, setLicenseFamiliesApproved, setLicenseFamiliesApproved, setLicenseFamiliesApprovedFile, setLicenseFamiliesDenied, setLicenseFamiliesDenied, setLicenseFamiliesDeniedFile, setLicenses, setLicenses, setLicensesApproved, setLicensesApproved, setLicensesApprovedFile, setLicensesDenied, setLicensesDenied, setLicensesDeniedFile, setListFamilies, setListLicenses, setNoDefaultLicenses, setOut, setOutputArchive, setOutputFamilies, setOutputFile, setOutputLicenses, setOutputStandard, setOutputStyle, setScanHiddenDirectories, setStylesheet, setXml, unsupportedArgs
@Parameter(defaultValue="${project.reporting.outputDirectory}", readonly=true, required=true) protected File outputDirectory
@Parameter(defaultValue="${session}", readonly=true, required=true) protected org.apache.maven.execution.MavenSession session
@Parameter(defaultValue="${project.remoteArtifactRepositories}", readonly=true, required=true) protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories
@Component protected org.apache.maven.doxia.tools.SiteTool siteTool
@Component protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
public void execute() throws org.apache.maven.plugin.MojoExecutionException
execute
in interface org.apache.maven.plugin.Mojo
org.apache.maven.plugin.MojoExecutionException
- if an error occurs when generating the reportMojo.execute()
@Deprecated public void generate(org.codehaus.doxia.sink.Sink sink, Locale locale) throws org.apache.maven.reporting.MavenReportException
generate(Sink, SinkFactory, Locale)
instead.generate
in interface org.apache.maven.reporting.MavenReport
sink
- the sink to use for the generation.locale
- the wanted locale to generate the report, could be null.org.apache.maven.reporting.MavenReportException
- if any@Deprecated public void generate(org.apache.maven.doxia.sink.Sink sink, Locale locale) throws org.apache.maven.reporting.MavenReportException
generate(Sink, SinkFactory, Locale)
instead.sink
- the sink to use for the generation.locale
- the wanted locale to generate the report, could be null.org.apache.maven.reporting.MavenReportException
- if anypublic void generate(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.sink.SinkFactory sinkFactory, Locale locale) throws org.apache.maven.reporting.MavenReportException
generate
in interface org.apache.maven.reporting.MavenMultiPageReport
sink
- the sink to use for the generation.sinkFactory
- the sink factory to use for the generation.locale
- the wanted locale to generate the report, could be null.org.apache.maven.reporting.MavenReportException
- if anypublic String getCategoryName()
getCategoryName
in interface org.apache.maven.reporting.MavenReport
public File getReportOutputDirectory()
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
protected String getOutputDirectory()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
protected String getInputEncoding()
null
.protected String getOutputEncoding()
null
.protected void closeReport()
public org.apache.maven.doxia.sink.Sink getSink()
public org.apache.maven.doxia.sink.SinkFactory getSinkFactory()
public boolean isExternalReport()
isExternalReport
in interface org.apache.maven.reporting.MavenReport
false
by default.MavenReport.isExternalReport()
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
protected void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
locale
- The locale to use for writing the report.org.apache.maven.reporting.MavenReportException
- Writing the report failed.public String getDescription(Locale locale)
getDescription
in interface org.apache.maven.reporting.MavenReport
locale
- Requested locale of the bundlepublic String getName(Locale locale)
getName
in interface org.apache.maven.reporting.MavenReport
locale
- Requested locale of the bundlepublic String getOutputName()
getOutputName
in interface org.apache.maven.reporting.MavenReport
Copyright © 2007–2024 Apache Software Foundation. All rights reserved.