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 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 PluginDescriptorGenerator
.
Notice that the help mojo source needs to be generated before compilation, but when Java annotations are used,
plugin descriptor content is available only after compilation (detecting annotations in .class files):
help mojo source can be generated with empty package only (and no plugin descriptor available yet), then needs
to be updated after compilation - through rewriteHelpMojo(PluginToolsRequest, Log)
which is called from
plugin descriptor XML generation.
- Since:
- 2.4
- Author:
- Vincent Siveton
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
execute(File destinationDirectory, PluginToolsRequest request)
Execute the generation for a given plugin descriptor.org.codehaus.plexus.velocity.VelocityComponent
setHelpPackageName(String helpPackageName)
setVelocityComponent(org.codehaus.plexus.velocity.VelocityComponent velocityComponent)
Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
-
Constructor Details
-
PluginHelpGenerator
public PluginHelpGenerator()Default constructor
-
-
Method Details
-
execute
public void execute(File destinationDirectory, PluginToolsRequest request) throws GeneratorExceptionExecute the generation for a given plugin descriptor.- Specified by:
execute
in interfaceGenerator
- Parameters:
destinationDirectory
- requiredrequest
- required- Throws:
GeneratorException
- if any
-
setHelpPackageName
-
getVelocityComponent
-
setVelocityComponent
public PluginHelpGenerator setVelocityComponent(org.codehaus.plexus.velocity.VelocityComponent velocityComponent)
-