Package org.apache.maven.tools.plugin.generator

Class PluginDescriptorGenerator

java.lang.Object

org.apache.maven.tools.plugin.generator.PluginDescriptorGenerator

All Implemented Interfaces:

Generator

public class PluginDescriptorGenerator
extends Object
implements Generator

Generate a Maven Plugin Descriptor XML file and corresponding plugin-help.xml help content for PluginHelpGenerator.

Constructor Summary

Constructors

Constructor	Description
PluginDescriptorGenerator(org.apache.maven.plugin.logging.Log log)

Method Summary

Modifier and Type	Method	Description
void	execute(File destinationDirectory, PluginToolsRequest request)	Execute the generation for a given plugin descriptor.
protected void	processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w)
protected void	processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w, boolean helpDescriptor)
void	writeDescriptor(File destinationFile, PluginToolsRequest request, boolean helpDescriptor)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginDescriptorGenerator

public PluginDescriptorGenerator(org.apache.maven.plugin.logging.Log log)

Method Detail

execute

public void execute(File destinationDirectory,
                    PluginToolsRequest request)
             throws GeneratorException

Execute the generation for a given plugin descriptor.

Specified by:

execute in interface Generator

Parameters:

destinationDirectory - required

request - required

Throws:

GeneratorException - if any

writeDescriptor

public void writeDescriptor(File destinationFile,
                            PluginToolsRequest request,
                            boolean helpDescriptor)
                     throws IOException,
                            org.apache.maven.plugin.descriptor.DuplicateMojoDescriptorException

Throws:

IOException

org.apache.maven.plugin.descriptor.DuplicateMojoDescriptorException

processMojoDescriptor

protected void processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                                     org.codehaus.plexus.util.xml.XMLWriter w)

processMojoDescriptor

protected void processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                                     org.codehaus.plexus.util.xml.XMLWriter w,
                                     boolean helpDescriptor)

Parameters:

mojoDescriptor - not null

w - not null

helpDescriptor - will clean html content from description fields