Package org.forgerock.doc.maven.pre

Class JCite

java.lang.Object

org.forgerock.doc.maven.pre.JCite

public class JCite
extends Object

Use JCite to quote Java code.

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
JCite(AbstractDocbkxMojo mojo)	Constructor setting the Mojo that holds the configuration.

Method Summary

Modifier and Type	Method	Description
void	execute()	Run JCite 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

JCite

public JCite(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

Run JCite on the XML source files.

Throws:

org.apache.maven.plugin.MojoExecutionException - Failed to run JCite.