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

Field Summary

Fields

Modifier and Type	Field	Description
private String	goalPrefix
private static final String	HELP_MOJO_CLASS_NAME	Default generated class name
private String	helpPackageName
private org.apache.maven.project.MavenProject	mavenProject
private boolean	useMaven4Api

Constructor Summary

Constructors

Constructor	Description
PluginHelpGenerator()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	execute(File destinationDirectory)
private String	getHelpClassSources(String pluginHelpPath)
private String	getImplementation()
(package private) static String	getPluginHelpPath(org.apache.maven.project.MavenProject mavenProject)
PluginHelpGenerator	setGoalPrefix(String goalPrefix)
PluginHelpGenerator	setHelpPackageName(String helpPackageName)
PluginHelpGenerator	setMavenProject(org.apache.maven.project.MavenProject mavenProject)

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

Field Details

HELP_MOJO_CLASS_NAME

private static final String HELP_MOJO_CLASS_NAME

Default generated class name

See Also:

• Constant Field Values

helpPackageName

private String helpPackageName

goalPrefix

private String goalPrefix

mavenProject

private org.apache.maven.project.MavenProject mavenProject

useMaven4Api

private boolean useMaven4Api

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)

setGoalPrefix

public PluginHelpGenerator setGoalPrefix(String goalPrefix)

setMavenProject

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

getHelpClassSources

private String getHelpClassSources(String pluginHelpPath)
                            throws IOException

Throws:

IOException

getImplementation

private String getImplementation()

Returns:

The implementation.

getPluginHelpPath

static String getPluginHelpPath(org.apache.maven.project.MavenProject mavenProject)