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

public class HelpGeneratorMojo
extends AbstractGeneratorMojo

Generates a HelpMojo class.

Since:

2.4

Version:

$Id: HelpGeneratorMojo.java 1337712 2012-05-12 22:41:56Z hboutemy $

Author:

Vincent Siveton

Is defined by the goal name:

helpmojo

Is bound to the specified phase of the standard build lifecycle:

generate-sources

Field Summary

protected File

outputDirectory The directory where the generated HelpMojo file will be put.

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

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

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

ROLE

Constructor Summary

HelpGeneratorMojo()

Method Summary

protected Generator	createGenerator()
void	execute()
protected 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

protected File outputDirectory

The directory where the generated HelpMojo file will be put.

Is defined by:

default-value:

${project.build.directory}/generated-sources/plugin

Constructor Detail

HelpGeneratorMojo

public HelpGeneratorMojo()

Method Detail

getOutputDirectory

protected File getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractGeneratorMojo

Returns:

the output directory where files will be generated.

createGenerator

protected 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