Package org.bsc.maven.confluence.plugin

Class PluginConfluenceDocGenerator

java.lang.Object

org.bsc.maven.confluence.plugin.PluginConfluenceDocGenerator

All Implemented Interfaces:

org.apache.maven.tools.plugin.generator.Generator

public abstract class PluginConfluenceDocGenerator
extends Object
implements org.apache.maven.tools.plugin.generator.Generator

Author:

Sorrentino

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_PLUGIN_TEMPLATE_WIKI

Constructor Summary

Constructors

Constructor	Description
PluginConfluenceDocGenerator()

Method Summary

Modifier and Type	Method	Description
void	execute(File destinationDirectory, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
void	execute(File destinationDirectory, org.apache.maven.tools.plugin.PluginToolsRequest request)
protected List<org.bsc.maven.confluence.plugin.PluginConfluenceDocGenerator.Goal>	writeGoalsAsChildren(Writer writer, String parentName, List<org.apache.maven.plugin.descriptor.MojoDescriptor> mojos)
protected void	writeSummary(Writer writer, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PLUGIN_TEMPLATE_WIKI

public static final String DEFAULT_PLUGIN_TEMPLATE_WIKI

See Also:

Constant Field Values

Constructor Detail

PluginConfluenceDocGenerator

public PluginConfluenceDocGenerator()

Method Detail

execute

public void execute(File destinationDirectory,
                    org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
             throws IOException

Parameters:

destinationDirectory -

pluginDescriptor -

Throws:

IOException

execute

public void execute(File destinationDirectory,
                    org.apache.maven.tools.plugin.PluginToolsRequest request)
             throws org.apache.maven.tools.plugin.generator.GeneratorException

Specified by:

execute in interface org.apache.maven.tools.plugin.generator.Generator

Parameters:

destinationDirectory -

request -

Throws:

org.apache.maven.tools.plugin.generator.GeneratorException

writeSummary

protected void writeSummary(Writer writer,
                            org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)

Parameters:

writer -

pluginDescriptor -

writeGoalsAsChildren

protected List<org.bsc.maven.confluence.plugin.PluginConfluenceDocGenerator.Goal> writeGoalsAsChildren(Writer writer,
                                                                                                       String parentName,
                                                                                                       List<org.apache.maven.plugin.descriptor.MojoDescriptor> mojos)