Package org.forgerock.doc.maven.pre

Class XCite

java.lang.Object

org.forgerock.doc.maven.pre.XCite

public class XCite
extends Object

Use the XCite Maven plugin to quote text files.

This class generates source including the citations. For example, if your DocBook source file includes the following <programlisting>:

 <programlisting language="java"
 >[jcp:org.forgerock.doc.jcite.test.Test:--- mainMethod]</programlisting>
 

Then this class replaces the citation with the code in between // --- mainMethod comments, suitable for inclusion in XML, and leaves the new file with the modifiable copy of the sources for further processing.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Run XCite on the XML source files.

Methods inherited from class java.lang.Object

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

Constructor Details

XCite

public XCite(AbstractDocbkxMojo mojo)

Constructor setting the Mojo that holds the configuration.

Parameters:

mojo - The Mojo that holds the configuration.

Method Details

execute

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

Run XCite on the XML source files.

Throws:

org.apache.maven.plugin.MojoExecutionException - Could not create output directory.

org.apache.maven.plugin.MojoFailureException - Failed to perform replacements.