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 aHelpMojo
class.- Since:
- 2.4
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
helpPackageName
The name of the package for the generatedHelpMojo
.protected java.io.File
outputDirectory
The directory where the generatedHelpMojo
file will be put.-
Fields inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
dependencies, encoding, extractors, goalPrefix, local, mojoScanner, packagingTypes, project, remoteRepos, skip, skipErrorNoDescriptorsFound
-
-
Constructor Summary
Constructors Constructor Description HelpGeneratorMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Generator
createGenerator()
void
execute()
protected java.io.File
getOutputDirectory()
-
-
-
Field Detail
-
outputDirectory
@Parameter(defaultValue="${project.build.directory}/generated-sources/plugin") protected java.io.File outputDirectory
The directory where the generatedHelpMojo
file will be put.
-
helpPackageName
@Parameter private java.lang.String 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
-
-
Method Detail
-
getOutputDirectory
protected java.io.File getOutputDirectory()
- Specified by:
getOutputDirectory
in classAbstractGeneratorMojo
- Returns:
- the output directory where files will be generated.
-
createGenerator
protected 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
-
-