org.jboss.maven.plugins.jdocbook.gen.format
Interface FormatHandler

All Known Implementing Classes:

BasicFormatHandler, PdfFormatHandler

public interface FormatHandler

Handles format-specific processing steps.

Author:

Steve Ebersole

Method Summary

void	attachOutput(java.io.File sourceFile, org.apache.maven.project.MavenProjectHelper projectHelper) Attaches the formatting output (after possibly bundling it into an archive) to the maven project.
java.io.File	prepareDirectory() This is used during the prepare-resources phase to create and prepare the format specific output directory for rendering.
void	render(java.io.File source) Performs the actual rendering or transforming of the DocBook sources into the respective output format.

Method Detail

prepareDirectory

java.io.File prepareDirectory()
                              throws RenderingException

This is used during the prepare-resources phase to create and prepare the format specific output directory for rendering. Generally, preparation might mean copying any format-specific resources to the format output directory.

Returns:

The format output directory

Throws:

RenderingException - Indicates problem preparing output directory

render

void render(java.io.File source)
            throws RenderingException,
                   XSLTException

Performs the actual rendering or transforming of the DocBook sources into the respective output format.

Parameters:

source - The source DocBook file.

Throws:

RenderingException - Problem writing the output file(s).

XSLTException - Problem performing XSL transformation.

attachOutput

void attachOutput(java.io.File sourceFile,
                  org.apache.maven.project.MavenProjectHelper projectHelper)
                  throws RenderingException

Attaches the formatting output (after possibly bundling it into an archive) to the maven project.

Parameters:

sourceFile - The source DocBook file.

projectHelper - The project helper (used to attach produced artifact)

Throws:

RenderingException - Indicates problem performing attaching