org.apache.maven.reporting
Class AbstractMavenReportTest
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.reporting.AbstractMavenReportTest
- All Implemented Interfaces:
- ContextEnabled, Mojo, MavenMultiPageReport, MavenReport
public class AbstractMavenReportTest
- extends AbstractMavenReport
Typical code to copy as a reporting plugin start: choose the goal name, then implement getOutputName(),
getName( Locale ), getDescription( Locale ) and of course executeReport( Locale ).
- Is defined by the goal name:
- test
Fields inherited from interface org.apache.maven.plugin.Mojo |
ROLE |
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
outputDirectory
protected File outputDirectory
- The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from
the command line. If the goal is run indirectly as part of a site generation, the output directory configured in
the Maven Site Plugin is used instead.
- Is defined by:
- expression:
- ${project.reporting.outputDirectory}
- Is required.
project
protected MavenProject project
- The Maven Project.
- Is defined by:
- expression:
- ${project}
- Is readonly.
- Is required.
siteRenderer
protected Renderer siteRenderer
- Doxia Site Renderer component.
- Is a Plexus component defined by:
AbstractMavenReportTest
public AbstractMavenReportTest()
getOutputDirectory
protected String getOutputDirectory()
- Specified by:
getOutputDirectory
in class AbstractMavenReport
getProject
protected MavenProject getProject()
- Specified by:
getProject
in class AbstractMavenReport
getSiteRenderer
protected Renderer getSiteRenderer()
- Specified by:
getSiteRenderer
in class AbstractMavenReport
getOutputName
public String getOutputName()
getName
public String getName(Locale locale)
getDescription
public String getDescription(Locale locale)
executeReport
protected void executeReport(Locale locale)
throws MavenReportException
- Specified by:
executeReport
in class AbstractMavenReport
- Throws:
MavenReportException
Copyright © 2002-2012 The Apache Software Foundation. All Rights Reserved.