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

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.tools.plugin.generator.PluginHelpGenerator

All Implemented Interfaces:

Generator, org.codehaus.plexus.logging.LogEnabled

public class PluginHelpGenerator
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements Generator

Generates an HelpMojo class.

Since:

2.4

Version:

$Id: PluginHelpGenerator.java 1354250 2012-06-26 21:36:53Z hboutemy $

Author:

Vincent Siveton

Constructor Summary

PluginHelpGenerator()
Default constructor

Method Summary

void	execute(File destinationDirectory, PluginToolsRequest request) Execute the generation for a given plugin descriptor.
org.codehaus.plexus.velocity.VelocityComponent	getVelocityComponent()
PluginHelpGenerator	setHelpPackageName(String helpPackageName)
PluginHelpGenerator	setVelocityComponent(org.codehaus.plexus.velocity.VelocityComponent velocityComponent)

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginHelpGenerator

public PluginHelpGenerator()

Default constructor

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

setHelpPackageName

public PluginHelpGenerator setHelpPackageName(String helpPackageName)

getVelocityComponent

public org.codehaus.plexus.velocity.VelocityComponent getVelocityComponent()

setVelocityComponent

public PluginHelpGenerator setVelocityComponent(org.codehaus.plexus.velocity.VelocityComponent velocityComponent)