org.apache.maven.reporting
Class AbstractMavenReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
- All Implemented Interfaces:
- org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport
- Direct Known Subclasses:
- AbstractMavenMultiPageReport
public abstract class AbstractMavenReport
- extends org.apache.maven.plugin.AbstractMojo
- implements org.apache.maven.reporting.MavenReport
The basis for a Maven report.
- Version:
- $Id: MavenReport.java 163376 2005-02-23 00:06:06Z brett $
- Author:
- Emmanuel Venisse
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 |
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 |
Methods inherited from interface org.apache.maven.reporting.MavenReport |
getDescription, getName, getOutputName |
AbstractMavenReport
public AbstractMavenReport()
getSiteRenderer
protected abstract org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getOutputDirectory
protected abstract String getOutputDirectory()
getProject
protected abstract org.apache.maven.project.MavenProject getProject()
execute
public void execute()
throws org.apache.maven.plugin.MojoExecutionException
- Specified by:
execute
in interface org.apache.maven.plugin.Mojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
- See Also:
Mojo.execute()
generate
public void generate(org.codehaus.doxia.sink.Sink sink,
Locale locale)
throws org.apache.maven.reporting.MavenReportException
- Specified by:
generate
in interface org.apache.maven.reporting.MavenReport
- Throws:
org.apache.maven.reporting.MavenReportException
- See Also:
MavenReport.generate(org.codehaus.doxia.sink.Sink, java.util.Locale)
executeReport
protected abstract void executeReport(Locale locale)
throws org.apache.maven.reporting.MavenReportException
- Throws:
org.apache.maven.reporting.MavenReportException
closeReport
protected void closeReport()
getCategoryName
public String getCategoryName()
- Specified by:
getCategoryName
in interface org.apache.maven.reporting.MavenReport
getReportOutputDirectory
public File getReportOutputDirectory()
- Specified by:
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
setReportOutputDirectory
public void setReportOutputDirectory(File reportOutputDirectory)
- Specified by:
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
getSink
public org.apache.maven.doxia.sink.Sink getSink()
isExternalReport
public boolean isExternalReport()
- Specified by:
isExternalReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
public boolean canGenerateReport()
- Specified by:
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
Copyright © 2001-2010 Apache Software Foundation. All Rights Reserved.