Package org.bsc.reporting.plugin

Class PluginConfluenceDocGenerator

java.lang.Object

org.bsc.reporting.plugin.PluginConfluenceDocGenerator

All Implemented Interfaces:

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

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

Author:

Sorrentino

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PluginConfluenceDocGenerator.Goal

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_PLUGIN_TEMPLATE_WIKI

Constructor Summary

Constructors

Constructor	Description
PluginConfluenceDocGenerator()

Method Summary

Modifier and Type	Method	Description
void	execute(java.io.File destinationDirectory, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
void	execute(java.io.File destinationDirectory, org.apache.maven.tools.plugin.PluginToolsRequest request)
protected java.util.List<PluginConfluenceDocGenerator.Goal>	writeGoalsAsChildren(java.io.Writer writer, java.lang.String parentName, java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor> mojos)
protected void	writeSummary(java.io.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 java.lang.String DEFAULT_PLUGIN_TEMPLATE_WIKI

See Also:

Constant Field Values

Constructor Detail

PluginConfluenceDocGenerator

public PluginConfluenceDocGenerator()

Method Detail

execute

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

Parameters:

destinationDirectory -

pluginDescriptor -

Throws:

java.io.IOException

execute

public void execute(java.io.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(java.io.Writer writer,
                            org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)

Parameters:

writer -

pluginDescriptor -

writeGoalsAsChildren

protected java.util.List<PluginConfluenceDocGenerator.Goal> writeGoalsAsChildren(java.io.Writer writer,
                                                                                 java.lang.String parentName,
                                                                                 java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor> mojos)