org.jdtaus.core.container.mojo

Class ContainerReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.jdtaus.core.container.mojo.ContainerReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenReport

public class ContainerReport
extends AbstractMavenReport

Generates a report for the artifact's container metadata.

Version:

$JDTAUS: ContainerReport.java 8743 2012-10-07 03:06:20Z schulte $

Author:

Christian Schulte

Is defined by the goal name:

report

Requires the dependencies in this specified scope:

runtime

Field Summary

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

Constructors

Constructor and Description
ContainerReport() Creates a new ContainerReport instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	executeReport(Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
protected SiteTool	getSiteTool() Gets the Site Tool implementation.
void	setReportOutputDirectory(File reportOutputDirectory)

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, getReportOutputDirectory, getSink, isExternalReport

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

ContainerReport

public ContainerReport()

Creates a new ContainerReport instance.

Method Detail

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface MavenReport

Overrides:

canGenerateReport in class AbstractMavenReport

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException

Specified by:

executeReport in class AbstractMavenReport

Throws:

MavenReportException

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface MavenReport

Overrides:

getCategoryName in class AbstractMavenReport

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getOutputDirectory

protected String getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractMavenReport

getOutputName

public String getOutputName()

getProject

protected MavenProject getProject()

Specified by:

getProject in class AbstractMavenReport

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

getSiteRenderer in class AbstractMavenReport

getSiteTool

protected final SiteTool getSiteTool()

Gets the Site Tool implementation.

Returns:

Site Tool implementation.

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface MavenReport

Overrides:

setReportOutputDirectory in class AbstractMavenReport