public abstract class AbstractProjectInfoReport extends AbstractMavenReport
Modifier and Type | Field and Description |
---|---|
protected String |
customBundle
Path for a custom bundle instead of using the default one.
|
protected org.apache.maven.artifact.factory.ArtifactFactory |
factory
Artifact Factory component.
|
protected ArtifactRepository |
localRepository
Local Repository.
|
protected org.apache.maven.project.MavenProjectBuilder |
mavenProjectBuilder
Project builder.
|
protected File |
outputDirectory
The output directory for the report.
|
protected org.apache.maven.project.MavenProject |
project
The Maven Project.
|
protected List<ArtifactRepository> |
remoteRepositories
Remote repositories used for the project.
|
protected ArtifactResolver |
resolver
Artifact Resolver component.
|
protected Settings |
settings
The current user system settings for use in Maven.
|
protected Renderer |
siteRenderer
Doxia Site Renderer component.
|
protected SiteTool |
siteTool
SiteTool component.
|
protected boolean |
skipEmptyReport
Skip the project info report generation if a report-specific section of the POM is empty.
|
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
Constructor and Description |
---|
AbstractProjectInfoReport() |
Modifier and Type | Method and Description |
---|---|
boolean |
canGenerateReport() |
void |
execute() |
String |
getCategoryName() |
String |
getDescription(Locale locale) |
protected org.codehaus.plexus.i18n.I18N |
getI18N(Locale locale) |
protected abstract String |
getI18Nsection() |
protected String |
getI18nString(Locale locale,
String key) |
String |
getName(Locale locale) |
protected String |
getOutputDirectory() |
protected Plugin |
getPlugin(String pluginId) |
protected String |
getPluginParameter(String pluginId,
String param) |
protected org.apache.maven.project.MavenProject |
getProject() |
File |
getReportOutputDirectory() |
protected Renderer |
getSiteRenderer() |
protected boolean |
isEmpty(Collection<?> coll) |
void |
setReportOutputDirectory(File reportOutputDirectory) |
closeReport, executeReport, generate, generate, generate, getInputEncoding, getOutputEncoding, getSink, getSinkFactory, isExternalReport
getLog, getPluginContext, setLog, setPluginContext
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getOutputName
@Component protected SiteTool siteTool
@Component protected Renderer siteRenderer
@Component protected ArtifactResolver resolver
@Component protected org.apache.maven.artifact.factory.ArtifactFactory factory
@Component protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder
@Parameter(property="project.reporting.outputDirectory", required=true) protected File outputDirectory
@Parameter(defaultValue="${project}", readonly=true, required=true) protected org.apache.maven.project.MavenProject project
@Parameter(property="localRepository", required=true, readonly=true) protected ArtifactRepository localRepository
@Parameter(property="project.remoteArtifactRepositories") protected List<ArtifactRepository> remoteRepositories
@Parameter(defaultValue="${settings}", readonly=true, required=true) protected Settings settings
@Parameter(defaultValue="${project.basedir}/src/site/custom/project-info-report.properties") protected String customBundle
@Parameter(defaultValue="true") protected boolean skipEmptyReport
true
.public boolean canGenerateReport()
canGenerateReport
in interface MavenReport
canGenerateReport
in class AbstractMavenReport
public void execute() throws MojoExecutionException
execute
in interface Mojo
execute
in class AbstractMavenReport
MojoExecutionException
public String getCategoryName()
getCategoryName
in interface MavenReport
getCategoryName
in class AbstractMavenReport
protected boolean isEmpty(Collection<?> coll)
coll
- The collection to be checked.protected String getOutputDirectory()
getOutputDirectory
in class AbstractMavenReport
public File getReportOutputDirectory()
getReportOutputDirectory
in interface MavenReport
getReportOutputDirectory
in class AbstractMavenReport
public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface MavenReport
setReportOutputDirectory
in class AbstractMavenReport
protected org.apache.maven.project.MavenProject getProject()
getProject
in class AbstractMavenReport
protected Plugin getPlugin(String pluginId)
pluginId
- The id of the pluginprotected String getPluginParameter(String pluginId, String param)
pluginId
- The pluginIdparam
- The child which should be checked.protected Renderer getSiteRenderer()
getSiteRenderer
in class AbstractMavenReport
protected String getI18nString(Locale locale, String key)
locale
- The localekey
- The key to search forprotected org.codehaus.plexus.i18n.I18N getI18N(Locale locale)
locale
- The local.protected abstract String getI18Nsection()
Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.