Package org.forgerock.doc.maven.build

Class Fo

java.lang.Object

org.forgerock.doc.maven.build.Fo

Direct Known Subclasses:

Pdf, Rtf

public class Fo
extends Object

Build FO output formats.

Constructor Summary

Constructors

Constructor	Description
Fo(AbstractDocbkxMojo mojo)	Constructor setting the Mojo that holds the configuration.

Method Summary

Modifier and Type	Method	Description
void	execute()	Build documents from DocBook XML sources.
String	getFormat()	Get the format.
void	setFormat(String format)	Set the format to PDF or RTF.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Fo

public Fo(AbstractDocbkxMojo mojo)

Constructor setting the Mojo that holds the configuration.

Parameters:

mojo - The Mojo that holds the configuration.

Method Details

getFormat

public String getFormat()

Get the format. Defaults to PDF unless the format has been set to RTF.

Returns:

The format, either "pdf" or "rtf".

setFormat

public void setFormat(String format)

Set the format to PDF or RTF. Defaults to PDF unless RTF is specified (case does not matter).

Parameters:

format - Either pdf or rtf.

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Build documents from DocBook XML sources.

Throws:

org.apache.maven.plugin.MojoExecutionException - Failed to build output.