org.apache.maven.tools.plugin.generator
Class PluginXdocGenerator

java.lang.Object
  org.apache.maven.tools.plugin.generator.PluginXdocGenerator

All Implemented Interfaces:

Generator

public class PluginXdocGenerator

extends java.lang.Object

implements Generator

Version:

$Id: PluginXdocGenerator.java 821512 2009-10-04 11:22:41Z bentmann $

Constructor Summary

PluginXdocGenerator()
Default constructor using Locale.ENGLISH as locale.

PluginXdocGenerator(org.apache.maven.project.MavenProject project)
Constructor using Locale.ENGLISH as locale.

PluginXdocGenerator(org.apache.maven.project.MavenProject project, java.util.Locale locale)

Method Summary

void	execute(java.io.File destinationDirectory, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor) Execute the generation for a given plugin descriptor.
void	execute(java.io.File destinationDirectory, PluginToolsRequest request) Execute the generation for a given plugin descriptor.
protected void	processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, java.io.File destinationDirectory)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginXdocGenerator

public PluginXdocGenerator()

Default constructor using Locale.ENGLISH as locale. Used only in test cases.

PluginXdocGenerator

public PluginXdocGenerator(org.apache.maven.project.MavenProject project)

Constructor using Locale.ENGLISH as locale.

Parameters:

project - not null Maven project.

PluginXdocGenerator

public PluginXdocGenerator(org.apache.maven.project.MavenProject project,
                           java.util.Locale locale)

Parameters:

project - not null.

locale - not null wanted locale.

Method Detail

execute

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

Execute the generation for a given plugin descriptor.

Specified by:

execute in interface Generator

Parameters:

destinationDirectory - required

pluginDescriptor - required

Throws:

java.io.IOException - if any

execute

public void execute(java.io.File destinationDirectory,
                    PluginToolsRequest request)
             throws java.io.IOException

Execute the generation for a given plugin descriptor.

Specified by:

execute in interface Generator

Parameters:

destinationDirectory - required

request - required

Throws:

java.io.IOException - if any

processMojoDescriptor

protected void processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                                     java.io.File destinationDirectory)
                              throws java.io.IOException

Parameters:

mojoDescriptor - not null

destinationDirectory - not null

Throws:

java.io.IOException - if any