Package 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:

org.codehaus.plexus.logging.LogEnabled

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

Generates an HelpMojo class from help-class-source.vm template. The generated mojo reads help content from META-INF/maven/${groupId}/${artifactId}/plugin-help.xml resource, which is generated by this PluginDescriptorFilesGenerator.

Since:

2.4

Author:

Vincent Siveton

Constructor Summary

Constructors

Constructor	Description
PluginHelpGenerator()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	execute(File destinationDirectory)
PluginHelpGenerator	setGoalPrefix(String goalPrefix)
PluginHelpGenerator	setHelpPackageName(String helpPackageName)
PluginHelpGenerator	setMavenProject(org.apache.maven.project.MavenProject mavenProject)
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 Details

PluginHelpGenerator

public PluginHelpGenerator()

Default constructor

Method Details

execute

public void execute(File destinationDirectory)
             throws GeneratorException

Throws:

GeneratorException

setHelpPackageName

public PluginHelpGenerator setHelpPackageName(String helpPackageName)

setVelocityComponent

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

setGoalPrefix

public PluginHelpGenerator setGoalPrefix(String goalPrefix)

setMavenProject

public PluginHelpGenerator setMavenProject(org.apache.maven.project.MavenProject mavenProject)