Package org.apache.maven.plugin.plugin

Class HelpGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.plugin.AbstractGeneratorMojo

org.apache.maven.plugin.plugin.HelpGeneratorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="helpmojo",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true,
      requiresDependencyResolution=COMPILE)
public class HelpGeneratorMojo
extends AbstractGeneratorMojo

Generates a HelpMojo class.

Since:

2.4

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	helpPackageName	The name of the package for the generated HelpMojo.
protected java.io.File	outputDirectory	The directory where the generated HelpMojo file will be put.
private org.codehaus.plexus.velocity.VelocityComponent	velocity	Velocity component.

Fields inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

dependencies, encoding, extractors, goalPrefix, local, mojoScanner, packagingTypes, project, remoteRepos, skip, skipErrorNoDescriptorsFound

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
HelpGeneratorMojo()

Method Summary

Modifier and Type	Method	Description
protected org.apache.maven.tools.plugin.generator.Generator	createGenerator()
void	execute()
protected java.io.File	getOutputDirectory()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

outputDirectory

@Parameter(defaultValue="${project.build.directory}/generated-sources/plugin")
protected java.io.File outputDirectory

The directory where the generated HelpMojo file will be put.

helpPackageName

@Parameter
private java.lang.String helpPackageName

The name of the package for the generated HelpMojo. By default, the package will be calculated based on the packages of the other plugin goals.

Since:

2.6

velocity

@Component
private org.codehaus.plexus.velocity.VelocityComponent velocity

Velocity component.

Constructor Detail

HelpGeneratorMojo

public HelpGeneratorMojo()

Method Detail

getOutputDirectory

protected java.io.File getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractGeneratorMojo

Returns:

the output directory where files will be generated.

createGenerator

protected org.apache.maven.tools.plugin.generator.Generator createGenerator()

Specified by:

createGenerator in class AbstractGeneratorMojo

Returns:

the wanted Generator implementation.

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractGeneratorMojo

Throws:

org.apache.maven.plugin.MojoExecutionException