PdfMojo (Apache Maven PDF Plugin 1.4 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugins.pdf.PdfMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
```
@Mojo(name="pdf",
      threadSafe=true)
public class PdfMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
```
Generates a PDF document for a project documentation usually published as web site (with maven-site-plugin).

Version:

$Id$

Author:

ltheussl

Field Summary
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor and Description

PdfMojo()

Constructors
Constructor and Description
`PdfMojo()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`contextualize(org.codehaus.plexus.context.Context context)`
`void`	`execute()`
`protected static String`	`getMavenVersion()`
`protected List<org.apache.maven.reporting.exec.MavenReportExecution>`	`getReports()`
`protected static boolean`	`isMaven3OrMore()` Check the current Maven version to see if it's Maven 3.0 or newer.

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
- PdfMojo
```
public PdfMojo()
```

Method Detail

execute
```
public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException
```
Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

contextualize
```
public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException
```
Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

getReports

protected List<org.apache.maven.reporting.exec.MavenReportExecution> getReports()
                                                                         throws org.apache.maven.plugin.MojoExecutionException

Throws:: org.apache.maven.plugin.MojoExecutionException

isMaven3OrMore
```
protected static boolean isMaven3OrMore()
```
Check the current Maven version to see if it's Maven 3.0 or newer.

getMavenVersion

protected static String getMavenVersion()

Class PdfMojo

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Constructor Detail

PdfMojo

Method Detail

execute

contextualize

getReports

isMaven3OrMore

getMavenVersion