org.apache.maven.plugin
Class PluginToTags

java.lang.Object
  org.apache.maven.plugin.PluginToTags

public class PluginToTags
extends Object

Constructor Summary

PluginToTags()

Method Summary

String	getPluginScript()
List	getTaglibs()
String	getXdoc()
void	setPluginScript(String pluginScript)
void	setXdoc(String outputFile)
void	transform() Transform the plugin script to the output file.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginToTags

public PluginToTags()

Method Detail

getXdoc

public String getXdoc()

Returns:

Returns the outputFile.

setXdoc

public void setXdoc(String outputFile)

Parameters:

outputFile - The outputFile to set.

getPluginScript

public String getPluginScript()

Returns:

Returns the pluginScript.

setPluginScript

public void setPluginScript(String pluginScript)

Parameters:

pluginScript - The plugin script to generate the docs from.

transform

public void transform()
               throws org.jdom.JDOMException,
                      IOException

Transform the plugin script to the output file. The output file will be in xdoc format.

Throws:

IOException - reading files

org.jdom.JDOMException - on xml

getTaglibs

public List getTaglibs()
                throws org.jdom.JDOMException,
                       IOException

Returns:

a list of tag libraries. Each element in the list is a Map. Each map contains an entry for "uri" (as a String) and one for tagNames (as a List).

Throws:

IOException - reading files

org.jdom.JDOMException - on xml