org.apache.maven.plugins.pdf

Class PdfAggregateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.pdf.AbstractPdfMojo

org.apache.maven.plugins.pdf.PdfMojo

org.apache.maven.plugins.pdf.PdfAggregateMojo

All Implemented Interfaces:

ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

@Mojo(name="aggregate",
      aggregator=true,
      requiresDependencyResolution=TEST,
      threadSafe=true)
 @Execute(goal="pdf")
public class PdfAggregateMojo
extends PdfMojo

Forks pdf goal then aggregates PDF content from all modules in the reactor.

Since:

1.5

Author:

anthony-beurive

Field Summary

Fields inherited from class org.apache.maven.plugins.pdf.PdfMojo

project

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
PdfAggregateMojo()

Method Summary

Modifier and Type	Method and Description
protected void	appendGeneratedReports(org.apache.maven.doxia.document.DocumentModel model, Locale locale) Append generated reports to the toc only if generateReports is enabled, for instance:
protected File	getOutputDirectory()
protected File	getWorkingDirectory()
protected boolean	isIncludeReports()
protected void	prepareTempSiteDirectory(File tmpSiteDir) Copy all site and generated-site files in the tmpSiteDirectory.

Methods inherited from class org.apache.maven.plugins.pdf.PdfMojo

contextualize, execute, getReports

Methods inherited from class org.apache.maven.plugins.pdf.AbstractPdfMojo

getSiteDirectoryTmp

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

PdfAggregateMojo

public PdfAggregateMojo()

Method Detail

getOutputDirectory

protected File getOutputDirectory()

Overrides:

getOutputDirectory in class PdfMojo

getWorkingDirectory

protected File getWorkingDirectory()

Overrides:

getWorkingDirectory in class PdfMojo

isIncludeReports

protected boolean isIncludeReports()

Overrides:

isIncludeReports in class PdfMojo

prepareTempSiteDirectory

protected void prepareTempSiteDirectory(File tmpSiteDir)

Description copied from class: PdfMojo

Copy all site and generated-site files in the tmpSiteDirectory.
Note: ignore copying of generated-site files if they already exist in the site dir.

Overrides:

prepareTempSiteDirectory in class PdfMojo

Parameters:

tmpSiteDir - not null

appendGeneratedReports

protected void appendGeneratedReports(org.apache.maven.doxia.document.DocumentModel model,
                                      Locale locale)

Description copied from class: PdfMojo

Append generated reports to the toc only if generateReports is enabled, for instance:

 <item name="Project Reports" ref="project-info">
   <item name="Project License" ref="license" />
   <item name="Project Team" ref="team-list" />
   <item name="Continuous Integration" ref="integration" />
   ...
 </item>
 

Overrides:

appendGeneratedReports in class PdfMojo

Parameters:

model - not null

locale - not null

See Also:

PdfMojo.generateMavenReports(Locale)