Package org.apache.maven.plugins.pdf

Klasse PdfMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.pdf.AbstractPdfMojo
org.apache.maven.plugins.pdf.PdfMojo
Alle implementierten Schnittstellen:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
Bekannte direkte Unterklassen:
PdfAggregateMojo
@Mojo(name="pdf", requiresDependencyResolution=TEST, threadSafe=true) public class PdfMojo extends AbstractPdfMojo 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).
Autor:
ltheussl

  • Felddetails

    • project

      @Parameter(defaultValue="${project}", readonly=true, required=true) protected org.apache.maven.project.MavenProject project
      The Maven Project Object.

  • Konstruktordetails

    • PdfMojo

      public PdfMojo()

  • Methodendetails

    • execute

      public void execute() throws org.apache.maven.plugin.MojoExecutionException
      Angegeben von:
      execute in Schnittstelle org.apache.maven.plugin.Mojo
      Löst aus:
      org.apache.maven.plugin.MojoExecutionException

    • contextualize

      public void contextualize(org.codehaus.plexus.context.Context context) throws org.codehaus.plexus.context.ContextException
      Angegeben von:
      contextualize in Schnittstelle org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
      Löst aus:
      org.codehaus.plexus.context.ContextException

    • getOutputDirectory

      protected File getOutputDirectory()
      Angegeben von:
      getOutputDirectory in Klasse AbstractPdfMojo

    • getWorkingDirectory

      protected File getWorkingDirectory()
      Angegeben von:
      getWorkingDirectory in Klasse AbstractPdfMojo

    • isIncludeReports

      protected boolean isIncludeReports()
      Angegeben von:
      isIncludeReports in Klasse AbstractPdfMojo

    • prepareTempSiteDirectory

      protected void prepareTempSiteDirectory(File tmpSiteDir) throws IOException
      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.
      Angegeben von:
      prepareTempSiteDirectory in Klasse AbstractPdfMojo
      Parameter:
      tmpSiteDir - not null
      Löst aus:
      IOException - if any
      Seit:
      1.1

    • appendGeneratedReports

      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: 
       <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>
      Parameter:
      model - not null
      locale - not null
      Seit:
      1.1
      Siehe auch:
      • generateMavenReports(Locale)

    • getReports

      protected List<org.apache.maven.reporting.exec.MavenReportExecution> getReports() throws org.apache.maven.plugin.MojoExecutionException
      Löst aus:
      org.apache.maven.plugin.MojoExecutionException