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
FieldsModifier and TypeFieldDescriptionprivate String
The name of the package for the generatedHelpMojo
.protected File
The directory where the generatedHelpMojo
file will be put.private org.codehaus.plexus.velocity.VelocityComponent
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 -
Method Summary
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
outputDirectory
@Parameter(defaultValue="${project.build.directory}/generated-sources/plugin") protected File outputDirectoryThe directory where the generatedHelpMojo
file will be put. -
helpPackageName
The name of the package for the generatedHelpMojo
. 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 velocityVelocity component.
-
-
Constructor Details
-
HelpGeneratorMojo
public HelpGeneratorMojo()
-
-
Method Details
-
getOutputDirectory
- Specified by:
getOutputDirectory
in classAbstractGeneratorMojo
- Returns:
- the output directory where files will be generated.
-
createGenerator
protected org.apache.maven.tools.plugin.generator.Generator createGenerator()- Specified by:
createGenerator
in classAbstractGeneratorMojo
- Returns:
- the wanted
Generator
implementation.
-
execute
public void execute() throws org.apache.maven.plugin.MojoExecutionException- Specified by:
execute
in interfaceorg.apache.maven.plugin.Mojo
- Overrides:
execute
in classAbstractGeneratorMojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
-